Clouds

Clouds is not creatable, there's only one instance of it. It can only be accessed through its globally exposed variable.

Clouds is a shortcut to Client.Clouds.

Clouds gives control over cloud settings.

Properties

number Altitude

Altitude of the clouds in world units. This is equivalent to Clouds.Min.Y

Color Color

Color of the clouds. If Clouds.IsUnlit is set to false, clouds color will blend with scene lighting.

number Height

Height of the volume dedicated to clouds generation. This is equivalent to Clouds.Size.Y.

boolean IsUnlit

Whether or not the Clouds should ignore scene lighting, false by default.

Number3 Max

Maximum world point of the volume dedicated to clouds generation.

Note: currently, [Clouds.Max.Y] isn't used.

Number3 Min

Minimum world point of the volume dedicated to clouds generation.

boolean On

Set to false to remove the clouds.

-- show clouds
Clouds.On = true
-- hide them
Clouds.On = false

Number3 Size

Size of the volume dedicated to clouds generation. This will set Clouds.Max according to given size.

Note: currently, vertical size isn't used.

number Width

Width of the volume dedicated to clouds generation. This is equivalent to Clouds.Size.X.