Difference between revisions of "setRain"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
+
{{Command
  
| ofpr |Game name=
+
| ofpr
  
|1.75|Game version=
+
|1.75
  
|gr1= Environment |GROUP1=
+
|gr1= Environment
  
  
  
|eff= global |Multiplayer Effects=
+
|eff= global
  
 
|serverExec= server |Exec=
 
|serverExec= server |Exec=
Line 19: Line 19:
 
* If executed on server, the changes will propagate globally.
 
* 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.
 
* 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'''.}}
  
| time [[setRain]] rain |SYNTAX=
+
| time [[setRain]] rain
  
|p1= time: [[Number]] - transition time to the new value in seconds |PARAMETER1=
+
|p1= time: [[Number]] - transition time to the new value in seconds
  
|p2= rain: [[Number]] - new rain value in range 0...1 |PARAMETER2=
+
|p2= rain: [[Number]] - new rain value in range 0...1
  
| [[Nothing]] |RETURNVALUE=
+
| [[Nothing]]
 
   
 
   
|x1= <code>60 [[setRain]] 1;</code> |EXAMPLE1=
+
|x1= <code>60 [[setRain]] 1;</code>
  
 
|x2= Force no rain: <code>0 [[setRain]] 0;
 
|x2= Force no rain: <code>0 [[setRain]] 0;
 
[[forceWeatherChange]];
 
[[forceWeatherChange]];
999999 [[setRain]] 0;</code> |EXAMPLE2=
+
999999 [[setRain]] 0;</code>
 
| 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=
  
| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]] |SEEALSO=
+
| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]
 
}}
 
}}
  

Revision as of 12:08, 18 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


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;