setRain

1.75

1.00

Hover & click on the images for description

Description

Description:

Sets rain density smoothly over the given transition time. A transition time of zero means an immediate change. A rain density of zero is no rain, one is maximum rain. Rain is not possible when overcast is less than 0.7.

Since Arma 3 this command is multiplayer synchronised:

If executed on server, the changes will propagate globally.
If executed on client, the effect is temporary and will soon change to the server setting.

Minimum overcast needed for rain in Arma 3 is 0.5.

Multiplayer:

Prior to Arma 3, each client and the server could have different rain values.

Groups:

Environment

Syntax 1

Syntax:: time setRain rain
Parameters:: time: Number - Transition time in seconds to the new value
: rain: Number - New rain value in range 0 to 1.
Return Value:: Nothing

2.08

Syntax 2

Syntax:: setRain rainParams
Parameters:: rainParams: Array - array of custom RainParticles params, see rainParams. Use empty array [] to reset to default config values
Return Value:: Nothing

2.08

Syntax 3

Syntax:: setRain config
Parameters:: config: Config - config path to a custom class, which contains RainParticles class. Use configNull to reset to default config values
Return Value:: Nothing

Examples

Example 1:: 60 setRain 1;
Example 2:: Force no rain: 0 setRain 0; forceWeatherChange; 999999 setRain 0;
Example 3:: Snow like effect (Since Arma 3 v2.08): 0 setOvercast 1; 0 setRain 1; forceWeatherChange; setRain [ "a3\data_f\rainnormal_ca.paa", // rainDropTexture 1, // texDropCount 0.01, // minRainDensity 15, // effectRadius 0.1, // windCoef 2, // dropSpeed 0.5, // rndSpeed 0.5, // rndDir 0.02, // dropWidth 0.02, // dropHeight [0.1,0.1,0.1,1], // dropColor 0.1, // lumSunFront 0.1, // lumSunBack 5.5, // refractCoef 0.3, // refractSaturation true, // snow false // dropColorStrong ];

Additional Information

See also:: rainParams overcast setOvercast rain nextWeatherChange forceWeatherChange setFog setHumidity

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

: Posted on December 15, 2015 - 14:31 (UTC)
Zapat: setTimeMultiplier does not affect transition time.

: Posted on November 16, 2016 - 22:06 (UTC)
Killzone Kid: Using Example 2 on dedicated server might need additional interference on JIP clients. The reason is that JIP has rain value > 0 slowly changing to 0. To force client to sync one can execute this on client:
skipTime 1; skipTime -1;