@minecraft/server-graphics 1.0.0-beta.1.26.3-stable → 1.0.0-beta.1.26.30-preview.25

package/README.md

@@ -1,9 +1,9 @@
-# `@minecraft/server-graphics`
-
-The `@minecraft/server-graphics` module contains APIs to change graphics and rendering settings.
-
-## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
-
-See full documentation for this module here:
-
+# `@minecraft/server-graphics`
+
+The `@minecraft/server-graphics` module contains APIs to change graphics and rendering settings.
+
+## **NOTE: This version of this module is still in pre-release.  It may change or it may be removed in future releases.**
+
+See full documentation for this module here:
+
 https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server-graphics/minecraft-server-graphics

package/index.d.ts

@@ -24,9 +24,10 @@
 import * as minecraftcommon from '@minecraft/common';
 import * as minecraftserver from '@minecraft/server';
 /**
- * Used to affect atmospheric scattering for Vibrant Visuals
+ * Used to affect atmospheric scattering per biome for Vibrant
+ * Visuals
  */
-export class Atmospherics {
+export class BiomeAtmospherics {
     private constructor();
     /**
      * @remarks
@@ -35,16 +36,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its
-     * horizon blend max overriden using scripting, then the
-     * override value will be removed and the biome will use the
-     * value provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetHorizonBlendMax(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetHorizonBlendMax(): void;
     /**
      * @remarks
      * Resets the horizon blend mie start to the value set by
@@ -52,16 +48,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its
-     * horizon blend mie start overriden using scripting, then the
-     * override value will be removed and the biome will use the
-     * value provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetHorizonBlendMieStart(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetHorizonBlendMieStart(): void;
     /**
      * @remarks
      * Resets the horizon blend min to the value set by resource
@@ -69,16 +60,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its
-     * horizon blend min overriden using scripting, then the
-     * override value will be removed and the biome will use the
-     * value provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetHorizonBlendMin(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetHorizonBlendMin(): void;
     /**
      * @remarks
      * Resets the horizon blend start to the value set by resource
@@ -86,16 +72,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its
-     * horizon blend start overriden using scripting, then the
-     * override value will be removed and the biome will use the
-     * value provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetHorizonBlendStart(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetHorizonBlendStart(): void;
     /**
      * @remarks
      * Resets the moon mie strength to the value set by resource
@@ -103,16 +84,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its
-     * moon mie strength overriden using scripting, then the
-     * override value will be removed and the biome will use the
-     * value provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetMoonMieStrength(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetMoonMieStrength(): void;
     /**
      * @remarks
      * Resets the rayleigh strength to the value set by resource
@@ -120,16 +96,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its
-     * rayleigh strength overriden using scripting, then the
-     * override value will be removed and the biome will use the
-     * value provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetRayleighStrength(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetRayleighStrength(): void;
     /**
      * @remarks
      * Resets the sky horizon color to the color set by resource
@@ -137,16 +108,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its sky
-     * horizon color overriden using scripting, then the override
-     * value will be removed and the biome will use the value
-     * provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetSkyHorizonColor(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetSkyHorizonColor(): void;
     /**
      * @remarks
      * Resets the sky zenith color to the color set by resource
@@ -154,16 +120,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its sky
-     * zenith color overriden using scripting, then the override
-     * value will be removed and the biome will use the value
-     * provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetSkyZenithColor(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetSkyZenithColor(): void;
     /**
      * @remarks
      * Resets the sun glare shape to the value set by resource
@@ -171,16 +132,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its sun
-     * glare shape overriden using scripting, then the override
-     * value will be removed and the biome will use the value
-     * provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetSunGlareShape(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetSunGlareShape(): void;
     /**
      * @remarks
      * Resets the sun mie strength to the value set by resource
@@ -188,16 +144,11 @@ export class Atmospherics {
      *
      * This function can't be called in restricted-execution mode.
      *
-     * @param biomeIdentifier
-     * Biome Identifier. If the corresponding biome has had its sun
-     * mie strength overriden using scripting, then the override
-     * value will be removed and the biome will use the value
-     * provided by json
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.EngineError}
      */
-    resetSunMieStrength(biomeIdentifier: minecraftserver.BiomeType): void;
+    resetSunMieStrength(): void;
     /**
      * @remarks
      * Sets the horizon blend max for atmospheric scattering in
@@ -211,14 +162,11 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,1])
-     * @param biomeIdentifier
-     * Biome Identifier. The horizon blend max will be set for the
-     * specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setHorizonBlendMax(blendMax: number | Record<number, number>, biomeIdentifier: minecraftserver.BiomeType): void;
+    setHorizonBlendMax(blendMax: number | Record<number, number>): void;
     /**
      * @remarks
      * Sets the horizon blend mie start for atmospheric scattering
@@ -232,17 +180,11 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,1.2])
-     * @param biomeIdentifier
-     * Biome Identifier. The horizon blend mie start will be set
-     * for the specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setHorizonBlendMieStart(
-        blendMieStart: number | Record<number, number>,
-        biomeIdentifier: minecraftserver.BiomeType,
-    ): void;
+    setHorizonBlendMieStart(blendMieStart: number | Record<number, number>): void;
     /**
      * @remarks
      * Sets the horizon blend min for atmospheric scattering in
@@ -256,14 +198,11 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,1])
-     * @param biomeIdentifier
-     * Biome Identifier. The horizon blend min will be set for the
-     * specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setHorizonBlendMin(blendMin: number | Record<number, number>, biomeIdentifier: minecraftserver.BiomeType): void;
+    setHorizonBlendMin(blendMin: number | Record<number, number>): void;
     /**
      * @remarks
      * Sets the horizon blend start for atmospheric scattering in
@@ -277,14 +216,11 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,1])
-     * @param biomeIdentifier
-     * Biome Identifier. The horizon blend start will be set for
-     * the specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setHorizonBlendStart(blendStart: number | Record<number, number>, biomeIdentifier: minecraftserver.BiomeType): void;
+    setHorizonBlendStart(blendStart: number | Record<number, number>): void;
     /**
      * @remarks
      * Sets the moon mie strength for atmospheric scattering in
@@ -298,17 +234,11 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,60])
-     * @param biomeIdentifier
-     * Biome Identifier. The moon mie strength will be set for the
-     * specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setMoonMieStrength(
-        moonMieStrength: number | Record<number, number>,
-        biomeIdentifier: minecraftserver.BiomeType,
-    ): void;
+    setMoonMieStrength(moonMieStrength: number | Record<number, number>): void;
     /**
      * @remarks
      * Sets the rayleigh strength for atmospheric scattering in
@@ -322,17 +252,11 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,11])
-     * @param biomeIdentifier
-     * Biome Identifier. The rayleigh strength will be set for the
-     * specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setRayleighStrength(
-        rayleighStrength: number | Record<number, number>,
-        biomeIdentifier: minecraftserver.BiomeType,
-    ): void;
+    setRayleighStrength(rayleighStrength: number | Record<number, number>): void;
     /**
      * @remarks
      * Sets the sky horizon color for atmospheric scattering in
@@ -346,17 +270,11 @@ export class Atmospherics {
      * [0,1]) to signify a time of day (0.0 and 1.0 are noon, 0.25
      * is sunset, 0.5 is midnight, and 0.75 is sunrise). The value
      * is a RGB triplet
-     * @param biomeIdentifier
-     * Biome Identifier. The sky horizon color will be set for the
-     * specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setSkyHorizonColor(
-        color: Record<number, minecraftserver.RGB> | minecraftserver.RGB,
-        biomeIdentifier: minecraftserver.BiomeType,
-    ): void;
+    setSkyHorizonColor(color: Record<number, minecraftserver.RGB> | minecraftserver.RGB): void;
     /**
      * @remarks
      * Sets the sky zenith color for atmospheric scattering in
@@ -369,17 +287,11 @@ export class Atmospherics {
      * are composed of key value pairs. The key is a float in the
      * range 0-1 to signify a time of day and the value is a RGB
      * triplet
-     * @param biomeIdentifier
-     * Biome Identifier. The sky zenith color will be set for the
-     * specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setSkyZenithColor(
-        color: Record<number, minecraftserver.RGB> | minecraftserver.RGB,
-        biomeIdentifier: minecraftserver.BiomeType,
-    ): void;
+    setSkyZenithColor(color: Record<number, minecraftserver.RGB> | minecraftserver.RGB): void;
     /**
      * @remarks
      * Sets the sun glare shape for atmospheric scattering in
@@ -393,14 +305,11 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,50])
-     * @param biomeIdentifier
-     * Biome Identifier. The sun glare shape will be set for the
-     * specified biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setSunGlareShape(sunGlareShape: number | Record<number, number>, biomeIdentifier: minecraftserver.BiomeType): void;
+    setSunGlareShape(sunGlareShape: number | Record<number, number>): void;
     /**
      * @remarks
      * Sets the sun mie strength for atmospheric scattering in
@@ -414,17 +323,19 @@ export class Atmospherics {
      * number (range [0,1]) to signify a time of day (0.0 and 1.0
      * are noon, 0.25 is sunset, 0.5 is midnight, and 0.75 is
      * sunrise). The value is also a number (range [0,60])
-     * @param biomeIdentifier
-     * Biome Identifier. The sun mie will be set for the specified
-     * biome.
      * @throws This function can throw errors.
      *
      * {@link minecraftcommon.InvalidArgumentError}
      */
-    setSunMieStrength(
-        sunMieStrength: number | Record<number, number>,
-        biomeIdentifier: minecraftserver.BiomeType,
-    ): void;
+    setSunMieStrength(sunMieStrength: number | Record<number, number>): void;
 }
 
-export const atmosphere: Atmospherics;
+/**
+ * @remarks
+ * Retrieves the BiomeAtmospherics component to control
+ * atmoshperic scattering for Vibrant Visuals.
+ *
+ * This function can't be called in restricted-execution mode.
+ *
+ */
+export function getBiomeAtmospherics(biome: minecraftserver.BiomeType): BiomeAtmospherics;

package/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "@minecraft/server-graphics",
-  "version": "1.0.0-beta.1.26.3-stable",
-  "description": "",
-  "contributors": [
-    {
-      "name": "Jake Shirley",
-      "email": "jake@xbox.com"
-    },
-    {
-      "name": "Mike Ammerlaan",
-      "email": "mikeam@microsoft.com"
-    }
-  ],
-  "peerDependencies": {
-    "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^1.17.0 || ^2.0.0 || ^2.6.0-beta.1.26.3-stable"
-  },
-  "license": "MIT"
+{
+  "name": "@minecraft/server-graphics",
+  "version": "1.0.0-beta.1.26.30-preview.25",
+  "description": "",
+  "contributors": [
+    {
+      "name": "Jake Shirley",
+      "email": "jake@xbox.com"
+    },
+    {
+      "name": "Mike Ammerlaan",
+      "email": "mikeam@microsoft.com"
+    }
+  ],
+  "peerDependencies": {
+    "@minecraft/common": "^1.0.0",
+    "@minecraft/server": "^1.17.0 || ^2.0.0 || ^2.9.0-beta.1.26.30-preview.25"
+  },
+  "license": "MIT"
 }