Difference between revisions of "GetRainLevel"

From Multi Theft Auto: Wiki
(Created page with "__NOTOC__ {{Server client function}} ==Syntax== <syntaxhighlight lang="lua"> float getRainLevel() </syntaxhighlight>")
 
(Extended the info.)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{Server client function}}
 
{{Server client function}}
 +
This function is used to get the current rain level.
 +
 +
'''Note:''' The server can only return the rain level if it has actually been set by script, otherwise it will return ''false''.
  
 
==Syntax==
 
==Syntax==
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
float getRainLevel()
+
float getRainLevel( )
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
===Returns===
 +
Returns the rain level as a number.

Revision as of 12:34, 4 September 2011

This function is used to get the current rain level.

Note: The server can only return the rain level if it has actually been set by script, otherwise it will return false.

Syntax

float getRainLevel( )

Returns

Returns the rain level as a number.