SetRainLevel: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} ==Syntax== <syntaxhighlight lang="lua"> bool setRainLevel ( float amount ) </syntaxhighlight>")
 
(Improve example and description.)
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server client function}}
{{Server client function}}
This function sets the rain level to any weather available in GTA. Use [[resetRainLevel]] to undo the changes.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setRainLevel ( float amount )
bool setRainLevel ( float level )
</syntaxhighlight>
</syntaxhighlight>
===Required Arguments===
*'''level:''' A floating point number representing the rain level. 1 represents the maximum rain level usually available in GTA, but higher values are accepted.
** '''Note:''' The level value is clamped between 0.0 and 10.0 to avoid gameplay issues.
===Returns===
Returns ''true'' if the rain level was set, ''false'' otherwise.
==Example==
<section name="Client" class="client" show="true">
This example will make it rain when player or ped enters a vehicle, and stop once it leaves.
<syntaxhighlight lang="lua">
function startRaining()
        setRainLevel(5)
end
addEventHandler("onClientVehicleEnter", root, startRaining)
function stopRaining()
        resetRainLevel()
end
addEventHandler("onClientVehicleExit", root, stopRaining)
</syntaxhighlight>
</section>
==See Also==
{{World functions}}

Latest revision as of 08:18, 16 September 2021

This function sets the rain level to any weather available in GTA. Use resetRainLevel to undo the changes.

Syntax

bool setRainLevel ( float level )

Required Arguments

  • level: A floating point number representing the rain level. 1 represents the maximum rain level usually available in GTA, but higher values are accepted.
    • Note: The level value is clamped between 0.0 and 10.0 to avoid gameplay issues.

Returns

Returns true if the rain level was set, false otherwise.

Example

Click to collapse [-]
Client

This example will make it rain when player or ped enters a vehicle, and stop once it leaves. 

function startRaining()
         setRainLevel(5)
end
addEventHandler("onClientVehicleEnter", root, startRaining)

function stopRaining()
         resetRainLevel()
end
addEventHandler("onClientVehicleExit", root, stopRaining)

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetRainLevel?oldid=72075"