@minecraft/server-graphics
    Preparing search index...

    Class BiomeAtmosphericsBeta

    Used to affect atmospheric scattering per biome for Vibrant Visuals

    Index

    Methods

    resetHorizonBlendMax resetHorizonBlendMieStart resetHorizonBlendMin resetHorizonBlendStart resetMoonMieStrength resetRayleighStrength resetSkyHorizonColor resetSkyZenithColor resetSunGlareShape resetSunMieStrength setHorizonBlendMax setHorizonBlendMieStart setHorizonBlendMin setHorizonBlendStart setMoonMieStrength setRayleighStrength setSkyHorizonColor setSkyZenithColor setSunGlareShape setSunMieStrength

    Methods

    • Beta

      Returns void

      Resets the horizon blend max to the value set by resource packs or via the 'setHorizonBlendMax' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the horizon blend mie start to the value set by resource packs or via the 'setHorizonBlendMieStart' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the horizon blend min to the value set by resource packs or via the 'setHorizonBlendMin' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the horizon blend start to the value set by resource packs or via the 'setHorizonBlendStart' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the moon mie strength to the value set by resource packs or via the 'setMoonMieStrength' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the rayleigh strength to the value set by resource packs or via the 'setRayleighStrength' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the sky horizon color to the color set by resource packs or via the 'setSkyHorizonColor' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the sky zenith color to the color set by resource packs or via the 'setSkyZenithColor' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the sun glare shape to the value set by resource packs or via the 'setSunGlareShape' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the sun mie strength to the value set by resource packs or via the 'setSunMieStrength' API in behavior packs

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Parameters

      • blendMax: number | Record<number, number>

        Either a number (range [0,1]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the horizon blend max for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • blendMieStart: number | Record<number, number>

        Either a number (range [0,1.2]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the horizon blend mie start for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • blendMin: number | Record<number, number>

        Either a number (range [0,1]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the horizon blend min for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • blendStart: number | Record<number, number>

        Either a number (range [0,1]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the horizon blend start for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • moonMieStrength: number | Record<number, number>

        Either a number (range [0,60]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the moon mie strength for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • rayleighStrength: number | Record<number, number>

        Either a number (range [0,11]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the rayleigh strength for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • color: RGB | Record<number, RGB>

        Either a RGB triplet or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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 a RGB triplet

      Returns void

      Sets the sky horizon color for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • color: RGB | Record<number, RGB>

        Either a RGB triplet or a set of keyframes. The keyframes 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

      Returns void

      Sets the sky zenith color for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • sunGlareShape: number | Record<number, number>

        Either a number (range [0,50]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the sun glare shape for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • sunMieStrength: number | Record<number, number>

        Either a number (range [0,60]) or a set of keyframes. The keyframes are composed of key value pairs. The key is a 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])

      Returns void

      Sets the sun mie strength for atmospheric scattering in Vibrant Visuals

      This function can't be called in restricted-execution mode.

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    Settings

    Member Visibility

    On This Page

    Methods