Difference between revisions of "setRain"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
 
{{Command|Comments=
 
{{Command|Comments=
____________________________________________________________________________________________
 
  
 
| ofpr |Game name=
 
| ofpr |Game name=
Line 13: Line 12:
  
 
|serverExec= server |Exec=
 
|serverExec= server |Exec=
____________________________________________________________________________________________
 
  
 
| Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change.
 
| Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change.
Line 22: Line 20:
 
* If executed on client, the effect is temporary and will soon change to the server setting.
 
* If executed on client, the effect is temporary and will soon change to the server setting.
 
Minimum [[overcast]] needed for rain in {{arma3}} is '''0.5'''.}}|DESCRIPTION=
 
Minimum [[overcast]] needed for rain in {{arma3}} is '''0.5'''.}}|DESCRIPTION=
____________________________________________________________________________________________
 
  
 
| time [[setRain]] rain |SYNTAX=
 
| time [[setRain]] rain |SYNTAX=
Line 31: Line 28:
  
 
| [[Nothing]] |RETURNVALUE=
 
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
 
 
   
 
   
 
|x1= <code>60 [[setRain]] 1;</code> |EXAMPLE1=
 
|x1= <code>60 [[setRain]] 1;</code> |EXAMPLE1=
Line 38: Line 34:
 
[[forceWeatherChange]];
 
[[forceWeatherChange]];
 
999999 [[setRain]] 0;</code> |EXAMPLE2=
 
999999 [[setRain]] 0;</code> |EXAMPLE2=
____________________________________________________________________________________________
 
 
| mp = Pre-Arma 3, each client and the server could have different rain values. |Multiplayer=
 
| mp = Pre-Arma 3, each client and the server could have different rain values. |Multiplayer=
  

Revision as of 03:50, 17 January 2021

Hover & click on the images for description

Description

Description:
Set rain density smoothly over the given transition time (in seconds). 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 MP 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:
Pre-Arma 3, each client and the server could have different rain values.
Groups:
Environment

Syntax

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

Examples

Example 1:
60 setRain 1;
Example 2:
Force no rain: 0 setRain 0; forceWeatherChange; 999999 setRain 0;

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

Notes

Bottom Section

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;