setRainLevel | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setRainLevel

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

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

  • bool: value

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

Code Examples

shared

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

World Functions
Reference