Difference between revisions of "setRain"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
Line 45: Line 45:
  
 
|r1= [[Nothing]]
 
|r1= [[Nothing]]
 +
 +
 +
|s2= [[setRain]] rainParams
 +
|p21= rainParams: [[Array]] - array of custom [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]] params, see [[rainParams]]. Use empty array [] to reset to default config values
 +
|s2since= arma3 2.08
 +
 +
|s3= [[setRain]] config
 +
|p41= config: [[Config]] - config path to a custom class, which contains [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]] class. Use [[configNull]] to reset to default config values
 +
|s3since= arma3 2.08
  
 
|x1= <code>60 [[setRain]] 1;</code>
 
|x1= <code>60 [[setRain]] 1;</code>
Line 51: Line 60:
 
[[forceWeatherChange]];
 
[[forceWeatherChange]];
 
999999 [[setRain]] 0;</code>
 
999999 [[setRain]] 0;</code>
 +
 +
|x3= Snow like effect (Since Arma 3 v2.08):<code>0 [[setOvercast]] 1;
 +
0 [[setRain]] 1;
 +
[[setRain]] ["a3\data_f\rainnormal_ca.paa",1,0.01,15,0.05,2,0.5,0.5,0.02,0.02,[0.1,0.1,0.1,1],0.1,0.1,5.5,0.3,true,false];</code>
 +
  
 
|seealso= [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]
 
|seealso= [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]

Revision as of 11:09, 1 November 2021

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 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

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; setRain ["a3\data_f\rainnormal_ca.paa",1,0.01,15,0.05,2,0.5,0.5,0.02,0.02,[0.1,0.1,0.1,1],0.1,0.1,5.5,0.3,true,false];

Additional Information

See also:
overcastsetOvercastrainnextWeatherChangeforceWeatherChangesetFog

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;