Difference between revisions of "SetWeatherBlended"

From Multi Theft Auto: Wiki
m (Example)
(It's not directly 2 hours, it's 1-2 hours)
 
Line 1: Line 1:
 
__NOTOC__  
 
__NOTOC__  
 
{{Server client function}}
 
{{Server client function}}
This function will change the current [[weather]] to another in a smooth manner, over the period of 2 in-game hours (unlike [[setWeather]], which sets a new weather instantly). To ensure this transition performs as expected, you should not call this function until [[getWeather]] indicates that no transition is already being done.
+
This function will change the current [[weather]] to another in a smooth manner, over the period of 1-2 in-game hours (unlike [[setWeather]], which sets a new weather instantly). To ensure this transition performs as expected, you should not call this function until [[getWeather]] indicates that no transition is already being done.
  
 
==Syntax==  
 
==Syntax==  
Line 15: Line 15:
  
 
==Example==  
 
==Example==  
This example sets the weather to sunny, then makes it change to a foggy over the period of two hours (assuming that a in-game hour is a minute in real time).
+
This example sets the weather to sunny, then makes it change to a foggy over the period of one-two hours (assuming that a in-game hour is a minute in real time).
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
-- Set the weather to sunny
 
-- Set the weather to sunny

Latest revision as of 10:31, 24 June 2018

This function will change the current weather to another in a smooth manner, over the period of 1-2 in-game hours (unlike setWeather, which sets a new weather instantly). To ensure this transition performs as expected, 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 one-two hours (assuming that a in-game hour is a minute in real time).

-- Set the weather to sunny
setWeather ( 0 )
-- Blend the weather to foggy
setWeatherBlended ( 9 )

See Also