setRain

From Bohemia Interactive Community
Jump to navigation Jump to search
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.
Arma 3
Since Arma 3 this command is multiplayer-synchronised:
  • if executed on the server, the changes will propagate globally.
  • if executed on a client, the effect is local, temporary and will soon change to the server setting.
Minimum overcast needed for rain in Arma 3 is 0.5.
Alternative syntaxes (Syntax 2 and Syntax 3):
  • set rain particle params. Rain particles params are client-side params and are ignored on dedicated server. Use helper function BIS_fnc_setRain if sync is needed in Multiplayer
  • have a local LELocal effect
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..1.
Return Value:
Nothing

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

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; 0 setFog 0.1; // snow affects visibility at distance setHumidity 0.9; // don't want to see dust clouds enableEnvironment [false, true]; // don't want to see snakes and butterflies either 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 ];
See also BIS_fnc_setRain since Arma 3 v2.10:
0 setOvercast 1; 0 setRain 1; 0 setFog 0.1; // snow affects visibility at distance setHumidity 0.9; // don't want to see dust clouds enableEnvironment [false, true]; // don't want to see snakes and butterflies either forceWeatherChange; [ "a3\data_f\snowflake4_ca.paa", // rainDropTexture 4, // texDropCount 0.01, // minRainDensity 25, // effectRadius 0.05, // windCoef 2.5, // dropSpeed 0.5, // rndSpeed 0.5, // rndDir 0.07, // dropWidth 0.07, // dropHeight [1, 1, 1, 0.5], // dropColor 0.0, // lumSunFront 0.2, // lumSunBack 0.5, // refractCoef 0.5, // refractSaturation true, // snow false // dropColorStrong ] call BIS_fnc_setRain;

Additional Information

See also:
rainParams BIS_fnc_setRain 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
Zapat
Posted on Dec 15, 2015 - 14:31 (UTC)
setTimeMultiplier does not affect transition time.
Killzone_Kid
Posted on Nov 16, 2016 - 22:06 (UTC)
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: