SetWeatherBlended

From Multi Theft Auto: Wiki
Revision as of 22:16, 12 November 2011 by Alan Williams (talk | contribs)
Jump to navigation Jump to search

This function will change the weather from the current weather (set using setWeather) to another weather state over a period of 60 seconds. The weather will be fully changed within 2 minutes. (Note: This is based on aan in-game minute duration of 1,000 milliseconds) To ensure smooth weather transition, you should not call this function until getWeather indicates that no transition is already being done.

Syntax

bool setWeatherBlended ( int weatherID )

Required Arguments

  • weatherID: The ID of the weather state you wish to set. Valid values are 0 to 255 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 )

See Also