Difference between revisions of "setRain"

From Bohemia Interactive Community
Jump to navigation Jump to search
(example)
Line 14: Line 14:
 
| time '''setRain''' rain |= Syntax
 
| time '''setRain''' rain |= Syntax
  
|p1= time: [[Number]]. In seconds |= Parameter 1
+
|p1= time: [[Number]] - transition time to the new value in seconds |= Parameter 1
  
|p2= rain: [[Number]]. Range 0 to 1 |= Parameter 2
+
|p2= rain: [[Number]] - new rain value in range 0...1 |= Parameter 2
  
 
| [[Nothing]] |= Return value
 
| [[Nothing]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <pre>60 setRain 1</pre> |= Example 1
+
|x1= <code>60 [[setRain]] 1;</code> |= Example 1
 +
 
 +
|x2= Force no rain: <code>0 [[setRain]] 0;
 +
[[forceWeatherChange]];
 +
999999 [[setRain]] 0;</code> |= Example 2
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
| mp = Each client and the server can have differing rain values. |= Multiplayer
 
| mp = Each client and the server can have differing rain values. |= Multiplayer
  
| [[overcast]], [[setOvercast]], [[rain]] |= See also
+
| [[overcast]], [[setOvercast]], [[rain]], [[fog]] |= See also
  
 
}}
 
}}

Revision as of 16:19, 23 March 2016

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.
Multiplayer:
Each client and the server can have differing rain values.
Groups:
Uncategorised

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

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.