SetWeatherBlended: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 14: | Line 14: | ||
==Example== | ==Example== | ||
This example sets the weather to sunny, then makes it change to a | This example sets the weather to sunny, then makes it change to a foggy over the period of a minute. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Set the weather to sunny | -- Set the weather to sunny | ||
setWeather ( 0 ) | setWeather ( 0 ) | ||
-- Blend the weather to | -- Blend the weather to foggy | ||
setWeatherBlended ( 9 ) | setWeatherBlended ( 9 ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 13:43, 20 May 2006
This function will change the weather from the current weather (set using setWeather) to another weather state over a period of 60 seconds.
Syntax
bool setWeatherBlended ( int weatherID )
Required Arguments
- weatherID: The ID of the weather state you wish to set. Valid values are 0 to 19 inclusive.
Returns
Returns true if successful, false if an invalid weatherID is passed.
Example
This example sets the weather to sunny, then makes it change to a foggy over the period of a minute.
-- Set the weather to sunny setWeather ( 0 ) -- Blend the weather to foggy setWeatherBlended ( 9 )