GetWeather: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(22 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
==Description==
{{Server client function}}
This function returns the current weather id.
This function returns the current [[Weather]] ID.


==Syntax==
==Syntax==
int [[getWeather]] ()
<syntaxhighlight lang="lua">
int, int getWeather()
</syntaxhighlight>
 
===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 is the weather id that is being blended into if any, otherwise it is ''nil''.


==Example==
==Example==
primary, secondary = [[getWeather]] ()
This example outputs the current weather ID in that chat box.
[[serverChat]] ( "The current weather is ", primary, " and ", secondary )
<syntaxhighlight lang="lua">local weatherID = getWeather()
outputChatBox ( "The current weather ID is " .. weatherID )</syntaxhighlight>
 
==See Also==
{{World functions}}
 
[[ru:getWeather]]

Latest revision as of 14:13, 7 October 2012

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 is the weather id that is being blended into if any, otherwise it is 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

Retrieved from "https://wiki.multitheftauto.com/wiki/GetWeather?oldid=33721"