setRain: Difference between revisions

Revision as of 16:41, 27 March 2021

1.75

1.00

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.

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

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

Examples

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

Additional Information

See also:: overcast setOvercast rain nextWeatherChange forceWeatherChange setFog

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;

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| ofpr
+|game1= ofp
-|1.75
+|version1= 1.75
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
+|game4= arma2
+|version4= 1.00
+|game5= arma2oa
+|version5= 1.51
+|game6= tkoh
+|version6= 1.00
+|game7= arma3
+|version7= 0.50
 |gr1= Environment
@@ Line 11: / Line 35: @@
 |serverExec= server
-| Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change.
+|descr= 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.
-{{Feature|arma3 | Since {{arma3}} this command is MP synchronised:
+{{Feature|arma3 | Since {{arma3}} 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 {{arma3}} is '''0.5'''.}}
-| time [[setRain]] rain
+|mp= Prior to {{arma3}}, each client and the server could have different rain values.
-|p1= time: [[Number]] - transition time to the new value in seconds
+|s1= time [[setRain]] rain
-|p2= rain: [[Number]] - new rain value in range 0...1
+|p1= time: [[Number]] - Transition time in seconds to the new value
-| [[Nothing]]
+|p2= rain: [[Number]] - New rain value in range 0 to 1.
+|r1= [[Nothing]]
 |x1= <code>60 [[setRain]] 1;</code>
@@ Line 32: / Line 58: @@
 [[forceWeatherChange]];
 [[setRain]] 0;</code>
-|mp= Pre-Arma 3, each client and the server could have different rain values.
 |seealso= [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]
 }}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}
-<!-- CONTINUE Notes -->
 <dl class="command_description">
 <dd class="notedate">Posted on December 15, 2015 - 14:31 (UTC)</dd>
 <dt class="note">[[User:Zapat|Zapat]]</dt>
 <dd class="note">
-[[setTimeMultiplier]] does NOT affect transition time.
+[[setTimeMultiplier]] does '''not''' affect transition time.
 </dd>
@@ Line 58: / Line 75: @@
 </dd>
 </dl>
-<!-- DISCONTINUE Notes -->