SetWeather: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 17: Line 17:


==Example==
==Example==
<section name="Server and Client" class="both" show="true">
This example will change the weather to foggy.
This example will change the weather to foggy.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 23: Line 22:
outputChatBox ( "Weather changed to foggy!" )
outputChatBox ( "Weather changed to foggy!" )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{World functions}}
{{World functions}}

Revision as of 09:41, 5 August 2007

This function instantly sets the current weather id to the given value.

To change the weather gradually, see setWeatherBlended.

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

This example will change the weather to foggy.

setWeather ( 9 )
outputChatBox ( "Weather changed to foggy!" )

See Also