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

    Class BiomeWaterBeta

    Used to affect water for Vibrant Visuals

    Index

    Methods

    • Beta

      Returns void

      Resets the CDOM to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the chlorophyll concentration to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the suspended sediment to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave depth to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave direction increment to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave frequency to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave frequency scaling to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave mix to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave octaves to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave pull to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave shape to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave speed to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Returns void

      Resets the wave speed scaling to the value set by resource packs

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

      This function can throw errors.

      minecraftcommon.EngineError

    • Beta

      Parameters

      • cdom: number

        A number (range [0,15]). Used to set the CDOM. High concentrations produce yellow to yellow-brown colors, due to CDOM strongly absorbing blue wavelengths. Open oceans typically have little to no CDOM, and thus retain a blue appearance; fresh water sources, like rivers, tend to have higher concentrations.

      Returns void

      Sets the CDOM for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • chlorophyll: number

        A number (range [0,10]). Used to set the chlorophyll concentration. High concentrations produce green colors, due to chlorophyll strongly absorbing blue and red wavelengths.

      Returns void

      Sets the chlorophyll concentration for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • suspendedSediment: number

        A number (range [0,300]). Used to set the suspended sediment. High concentrations produce red to red-brown colors, due to suspended sediment strongly absorbing blue and green wavelengths. Suspended sediment, like clay and silt, tend to be concentrated in rivers and can indicate recent floods or sources of pollution.

      Returns void

      Sets the suspended sediment for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesDepth: number

        A number (range [0,10]). Used to set the wave depth. Determines how much waves displace the water surface. Larger values will result in deeper waves, whereas smaller values will produce shallower waves.

      Returns void

      Sets the wave depth for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesDirectionIncrement: number

        A number (range [0.0f, 360.0f]). Used to set the wave direction increment. An angle, in degrees, that controls how much the heading changes between each octave.

      Returns void

      Sets the wave direction increment for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesFrequency: number

        A number (range [0,10]). Used to set the wave frequency. Determines how many waves there are per water block. Can also be thought of as the size of the waves. Larger values will create more tightly packed waves, whereas smaller values will spread waves out over a wider area.

      Returns void

      Sets the wave frequency for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesFrequencyScaling: number

        A number (range [0,2]). Used to set the wave frequency scaling. Specifies how much wave frequency changes between octaves. A value of 1 will result in no change between octaves. Values higher than 1 will cause frequencies to increase while values less than 1 will cause frequencies to decrease.

      Returns void

      Sets the wave frequency scaling for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesMix: number

        A number (range [0.0, 1.0]). Used to set the wave mix. Controls how much each octave is blended into the neighboring octave.

      Returns void

      Sets the wave mix for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesOctaves: number

        A number (range [1.0, 10]). Used to set the wave octaves. Determines how many layers of waves to simulate; high values result in more complex waves

      Returns void

      Sets the wave octaves for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesPull: number

        A number (range [-1.0f, 1.0f]). Used to set the wave pull. Controls how much smaller waves are pulled into larger waves. A value of 0 results in no pull. Values larger than 0 will pull waves in a standard concave fashion, whereas values less than 0 will pull waves in a convex fashion, resulting in more pillowing waves as opposed to cresting waves.

      Returns void

      Sets the wave pull for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesShape: number

        A number (range [1.0, 10]). Used to set the wave shape. Adjusts the core shape of waves. A value of 1 results in a pure sine wave, whereas values larger than 1 will produce sharper waves.

      Returns void

      Sets the wave shape for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesSpeed: number

        A number (range [0.01,10]). Used to set the wave speed. etermines the movement speed of the first wave and the starting value of the Speed Scaling parameter.

      Returns void

      Sets the wave speed for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError

    • Beta

      Parameters

      • wavesSpeedScaling: number

        A number (range [0.0,2]). Used to set the wave speed scaling. Controls how much faster each subsequent octave moves. A value of 1 will result in no change between octaves. Values higher than 1 will cause speeds to increase while values less than 1 will cause speeds to decrease.

      Returns void

      Sets the wave speed scaling for water in Vibrant Visuals

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

      This function can throw errors.

      minecraftcommon.InvalidArgumentError