GetRainLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:
This function is used to get the current rain level.
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''.
{{Note|The function will return ''false'' server-side if sun size has not been set before the function is called.}}
 
==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 17:05, 20 May 2020

This function is used to get the current rain level.

[[{{{image}}}|link=|]] Note: The function will return false server-side if sun size has not been set before the function is called.

Syntax

float getRainLevel( )

Returns

Returns the rain level as a number.

Example

Click to collapse [-]
Client

Example: Sets the rain (So it can detect it) before returning it. (In this case, when resource starts.)

addEventHandler("onClientResourceStart", getResourceRootElement(), function()
	setRainLevel(math.random(5))
end)
function returnRain()
	local rain = getRainlevel()
	if(rain >= 1) then
		outputChatBox("Looks like it's going to be a rainy day!",255,130,130,false)
	else
		outputChatBox("Surprisingly dry!",255,130,130,false)
	end
end
addCommandHandler("rain", returnRain)
Click to collapse [-]
Server

Example: Sets the rain (So it can detect it) before returning it. (In this case, when resource starts.)

addEventHandler("onResourceStart", getResourceRootElement(), function()
	setRainLevel(math.random(5))
end)

function returnRain(player)
	local rain = getRainlevel()
	if(rain >= 1) then
		outputChatBox("Looks like it's going to be a rainy day!",player,255,130,130,false)
	else
		outputChatBox("Surprisingly dry!",player,255,130,130,false)
	end
end
addCommandHandler("rain", returnRain)

See Also