GetRainLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Replace to predefined variables.)
 
(6 intermediate revisions by 3 users not shown)
Line 2: Line 2:
{{Server client function}}
{{Server client function}}
This function is used to get the current rain level.
This function is used to get the current rain level.
 
{{Note|The function will return ''false'' server-side if rain level has not been set before the function is called.}}
'''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">
Line 17: Line 15:
'''Example:''' Sets the rain (So it can detect it) before returning it. (In this case, when resource starts.)
'''Example:''' Sets the rain (So it can detect it) before returning it. (In this case, when resource starts.)
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), function()
addEventHandler("onClientResourceStart", resourceRoot, function()
setRainLevel(5)
setRainLevel(math.random(5))
end)
end)
function returnRain()
function returnRain()
local rain = getRainlevel()
local rain = getRainlevel()
Line 35: Line 34:
'''Example:''' Sets the rain (So it can detect it) before returning it. (In this case, when resource starts.)
'''Example:''' Sets the rain (So it can detect it) before returning it. (In this case, when resource starts.)
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()), function()
addEventHandler("onResourceStart", resourceRoot, function()
setRainLevel(5)
setRainLevel(math.random(5))
end)
end)


Latest revision as of 23:12, 11 January 2023

This function is used to get the current rain level.

[[{{{image}}}|link=|]] Note: The function will return false server-side if rain level 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", resourceRoot, 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", resourceRoot, 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


Retrieved from "https://wiki.multitheftauto.com/wiki/GetRainLevel?oldid=76003"