Difference between revisions of "setRain"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
 
(43 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofpr |= Game name
+
|game1= ofp
 +
|version1= 1.75
  
|1.75|= Game version
+
|game2= ofpe
 +
|version2= 1.00
  
|eff= local |= Effects in MP
+
|game3= arma1
____________________________________________________________________________________________
+
|version3= 1.00
  
| 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. |= Description
+
|game4= arma2
____________________________________________________________________________________________
+
|version4= 1.00
  
| time '''setRain''' rain |= Syntax
+
|game5= arma2oa
 +
|version5= 1.50
  
|p1= time: [[Number]]. In seconds |= Parameter 1
+
|game6= tkoh
 +
|version6= 1.00
  
|p2= rain: [[Number]]. Range 0 to 1 |= Parameter 2
+
|game7= arma3
 +
|version7= 0.50
  
| [[Nothing]] |= Return value
+
|gr1= Environment
____________________________________________________________________________________________
 
 
 
|x1= <pre>60 setRain 1</pre> |= Example 1
 
____________________________________________________________________________________________
 
| mp = Each client and the server can have differing rain values. |= Multiplayer
 
  
| [[overcast]], [[setOvercast]], [[rain]] |= See also
+
|eff= global
  
 +
|serverExec= server
 +
 +
|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 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'''.}}
 +
 +
|mp= Prior to {{arma3}}, each client and the server could have different rain values.
 +
 +
|s1= time [[setRain]] rain
 +
 +
|p1= time: [[Number]] - Transition time in seconds to the new value
 +
 +
|p2= rain: [[Number]] - New rain value in range 0 to 1.
 +
 +
|r1= [[Nothing]]
 +
 +
|x1= <code>60 [[setRain]] 1;</code>
 +
 +
|x2= Force no rain: <code>0 [[setRain]] 0;
 +
[[forceWeatherChange]];
 +
999999 [[setRain]] 0;</code>
 +
 +
|seealso= [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
 
  
<!-- Note Section END -->
+
<dt></dt>
 +
<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.
 +
</dd>
 +
 
 +
<dt><dt>
 +
<dd class="notedate">Posted on November 16, 2016 - 22:06 (UTC)</dd>
 +
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 +
<dd class="note">
 +
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: <code>[[skipTime]] 1; [[skipTime]] -1;</code>
 +
</dd>
 +
 
 
</dl>
 
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|SETRAIN]]
 
[[Category:Scripting Commands OFP 1.96|SETRAIN]]
 
[[Category:Scripting Commands ArmA|SETRAIN]]
 
[[Category:Scripting Commands ArmA2|SETRAIN]]
 
[[Category:Command_Group:_Environment|SETRAIN]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 17:10, 13 June 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

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