GetWeather: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 5: Line 5:
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int getWeather()
int,int getWeather()
</syntaxhighlight>
</syntaxhighlight>


===Returns===
===Returns===
Returns an integer indicating the weather type that is currently active. This can vary from area to area of the map.
Returns two integers indicating the weather type that is currently active. The first integer says what weather is currently considered to be active, the second integer says what weather is being blended into. The second integer is the weather id that is being blended into if any, otherwize nil.


==Example==
==Example==

Revision as of 23:59, 21 December 2007

This function returns the current weather id.

Syntax

int,int getWeather()

Returns

Returns two integers indicating the weather type that is currently active. The first integer says what weather is currently considered to be active, the second integer says what weather is being blended into. The second integer is the weather id that is being blended into if any, otherwize nil.

Example

This example outputs the current weather ID in that chat box.

local weatherID = getWeather()
outputChatBox ( "The current weather ID is " .. weatherID )

See Also