WeatherChangeBeforeEvent Class

Caution

This class is still in pre-release. Its signature may change or it may be removed in future releases.

Contains information related to changes in weather in the environment.

Properties

cancel: boolean;

If set to true the weather change will be cancelled.

Type: boolean

duration: number;

Sets the duration of the new weather (in ticks).

Type: number

newWeather: WeatherType;

The type of weather that will be applied.

read-only previousWeather: WeatherType;

The type of weather that it was prior to the event being fired.