SetRainLevel

From Multi Theft Auto: Wiki
Revision as of 08:18, 16 September 2021 by Srslyyyy (talk | contribs) (Improve example and description.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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