SetWeather: Difference between revisions

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


===Required Arguments===
===Required Arguments===
*'''weatherID''': The new weather id. Valid values are 0 to 19 inclusive.
*'''weatherID''': The new weather id. Valid values are 0 to 255 inclusive.


===Returns===
===Returns===

Revision as of 10:49, 14 August 2009

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 255 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