Difference between revisions of "PushEnvironmentWeatherOverride"
From Nomad DB
(Created page with "Starts the specified weather preset within the specified fade duration. == Syntax == <syntaxhighlight lang="lua"> PushEnvironmentWeatherOverride(weatherPreset, fadeIn) </synt...") |
m |
||
| Line 5: | Line 5: | ||
PushEnvironmentWeatherOverride(weatherPreset, fadeIn) | PushEnvironmentWeatherOverride(weatherPreset, fadeIn) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | * '''weatherPreset''' (string): | + | * '''weatherPreset''' (string): ID of the weather preset to be started (corresponds to an item in the '''WeatherPreset''' library) |
| − | * '''fadeIn''' (number): | + | * '''fadeIn''' (number): Number of seconds it takes for the specified weather to fade in |
== Example == | == Example == | ||
Latest revision as of 18:51, 16 April 2020
Starts the specified weather preset within the specified fade duration.
Syntax
PushEnvironmentWeatherOverride(weatherPreset, fadeIn)
- weatherPreset (string): ID of the weather preset to be started (corresponds to an item in the WeatherPreset library)
- fadeIn (number): Number of seconds it takes for the specified weather to fade in
Example
Starts a very foggy weather preset within 3 seconds.
PushEnvironmentWeatherOverride("WeatherPreset.9223372056453997549", 3)
