Difference between revisions of "setRain"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Add A3 details)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| ofpr |= Game name
+
| ofpr |Game name=
  
|1.75|= Game version
+
|1.75|Game version=
  
|eff= global|Multiplayer Effects=
+
|eff= global |Multiplayer Effects=
|exec= server|= Exec
+
 
 +
|exec= server |Exec=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| 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.
+
| Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change.
<br><br>
+
A rain density of zero is no rain, one is maximum rain. Rain is not possible when [[overcast]] is less than 0.7.
'''NOTE''': Since Arma 3 this command is MP synchronised, if executed on server, the changes will propagate globally. If executed on client effect is temporary as it will soon change to the server setting. |DESCRIPTION= |DESCRIPTION=
+
 
 +
{{Feature arma3 | Since {{arma3}} 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 {{arma3}} is '''0.5'''.}}|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| time '''setRain''' rain |SYNTAX=
+
| time [[setRain]] rain |SYNTAX=
  
 
|p1= time: [[Number]] - transition time to the new value in seconds |PARAMETER1=
 
|p1= time: [[Number]] - transition time to the new value in seconds |PARAMETER1=
Line 30: Line 35:
 
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=
  
 
| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]  |SEEALSO=
 
| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]  |SEEALSO=
 
 
}}
 
}}
  
Line 44: Line 48:
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|SETRAIN]]
+
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|SETRAIN]]
+
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|SETRAIN]]
 
[[Category:Scripting Commands ArmA2|SETRAIN]]
 
[[Category:Command_Group:_Environment|SETRAIN]]
 
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]
  
 
<!-- CONTINUE Notes -->
 
<!-- CONTINUE Notes -->

Revision as of 00:24, 24 August 2019

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. Template:Feature arma3
Multiplayer:
Pre-Arma 3, each client and the server could have different 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:
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;