SetWeather: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function sets the current [[weather]] to the given valid value.
This function sets the current [[weather]] to the given valid value. To change the weather gradually, see [[setWeatherBlended]].
 
To change the weather gradually, see [[setWeatherBlended]].


==Syntax==
==Syntax==

Revision as of 19:02, 18 September 2013

This function sets the current weather to the given valid 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