SetWeather: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">setWeather ( | <syntaxhighlight lang="lua"> | ||
bool setWeather ( int weatherID ) | |||
</syntaxhighlight> | |||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''weatherID''': The new weather id. Valid values are 0 to 19 inclusive. | ||
===Returns=== | |||
Returns ''true'' if the weather was set succesfully, ''false'' if an invalid ''weatherID'' was specified. | |||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua">setWeather ( 9 ) | <syntaxhighlight lang="lua"> | ||
outputChatBox ( "Weather changed to foggy!" )</syntaxhighlight> | setWeather ( 9 ) | ||
outputChatBox ( "Weather changed to foggy!" ) | |||
</syntaxhighlight> | |||
{{World_Functions}} | |||
Revision as of 13:41, 20 May 2006
Description
This function sets the current weather id to the given value.
Syntax
bool setWeather ( int weatherID )
Required Arguments
- weatherID: The new weather id. Valid values are 0 to 19 inclusive.
Returns
Returns true if the weather was set succesfully, false if an invalid weatherID was specified.
Example
setWeather ( 9 ) outputChatBox ( "Weather changed to foggy!" )