Difference between revisions of "setRain"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2")
m (Replaced <code> with <sqf>)
 
(60 intermediate revisions by 4 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= global |Multiplayer Effects=
+
|game3= arma1
 +
|version3= 1.00
  
|exec= server |Exec=
+
|game4= arma2
____________________________________________________________________________________________
+
|version4= 1.00
  
| Set rain density smoothly over the given transition time (in seconds). A transition time of zero means an immediate change.
+
|game5= arma2oa
 +
|version5= 1.50
 +
 
 +
|game6= tkoh
 +
|version6= 1.00
 +
 
 +
|game7= arma3
 +
|version7= 0.50
 +
 
 +
|gr1= Environment
 +
 
 +
|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.
 
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 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'''.}}
____________________________________________________________________________________________
+
 
 +
|mp= Prior to {{arma3}}, each client and the server could have different rain values.
 +
 
 +
|s1= time [[setRain]] rain
  
| time [[setRain]] rain |SYNTAX=
+
|p1= time: [[Number]] - Transition time in seconds to the new value
  
|p1= time: [[Number]] - transition time to the new value in seconds |PARAMETER1=
+
|p2= rain: [[Number]] - New rain value in range 0 to 1.
  
|p2= rain: [[Number]] - new rain value in range 0...1 |PARAMETER2=
+
|r1= [[Nothing]]
  
| [[Nothing]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
 
 
|x1= <code>60 [[setRain]] 1;</code> |EXAMPLE1=
 
  
|x2= Force no rain: <code>0 [[setRain]] 0;
+
|s2= [[setRain]] rainParams
[[forceWeatherChange]];
+
|p21= rainParams: [[Array]] - array of custom [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]] params, see [[rainParams]]. Use empty array [] to reset to default config values
999999 [[setRain]] 0;</code> |EXAMPLE2=
+
|s2since= arma3 2.08
____________________________________________________________________________________________
 
| mp = Pre-Arma 3, each client and the server could have different rain values. |Multiplayer=
 
  
| [[overcast]], [[setOvercast]], [[rain]], [[nextWeatherChange]], [[forceWeatherChange]], [[setFog]]  |SEEALSO=
+
|s3= [[setRain]] config
}}
+
|p41= config: [[Config]] - config path to a custom class, which contains [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]] class. Use [[configNull]] to reset to default config values
 +
|s3since= arma3 2.08
 +
 
 +
|x1= <sqf>60 setRain 1;</sqf>
  
<h3 style="display:none">Notes</h3>
+
|x2= Force no rain:
<dl class="command_description">
+
<sqf>0 setRain 0;
<!-- Note Section BEGIN -->
+
forceWeatherChange;
 +
999999 setRain 0;</sqf>
  
<!-- Note Section END -->
+
|x3= Snow like effect (Since Arma 3 v2.08):
</dl>
+
<sqf>0 setOvercast 1;
 +
0 setRain 1;
 +
forceWeatherChange;
 +
setRain [
 +
"a3\data_f\rainnormal_ca.paa", // rainDropTexture
 +
1, // texDropCount
 +
0.01, // minRainDensity
 +
15, // effectRadius
 +
0.1, // windCoef
 +
2, // dropSpeed
 +
0.5, // rndSpeed
 +
0.5, // rndDir
 +
0.02, // dropWidth
 +
0.02, // dropHeight
 +
[0.1, 0.1, 0.1, 1], // dropColor
 +
0.1, // lumSunFront
 +
0.1, // lumSunBack
 +
5.5, // refractCoef
 +
0.3, // refractSaturation
 +
true, // snow
 +
false // dropColorStrong
 +
];</sqf>
  
<h3 style="display:none">Bottom Section</h3>
+
|seealso= [[rainParams]] [[overcast]] [[setOvercast]] [[rain]] [[nextWeatherChange]] [[forceWeatherChange]] [[setFog]] [[setHumidity]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+
}}
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]
 
  
<!-- CONTINUE Notes -->
 
 
<dl class="command_description">
 
<dl class="command_description">
 +
 +
<dt></dt>
 
<dd class="notedate">Posted on December 15, 2015 - 14:31 (UTC)</dd>
 
<dd class="notedate">Posted on December 15, 2015 - 14:31 (UTC)</dd>
 
<dt class="note">[[User:Zapat|Zapat]]</dt>
 
<dt class="note">[[User:Zapat|Zapat]]</dt>
 
<dd class="note">
 
<dd class="note">
[[setTimeMultiplier]] does NOT affect transition time.
+
[[setTimeMultiplier]] does '''not''' affect transition time.
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
+
<dt><dt>
<dl class="command_description">
 
 
<dd class="notedate">Posted on November 16, 2016 - 22:06 (UTC)</dd>
 
<dd class="notedate">Posted on November 16, 2016 - 22:06 (UTC)</dd>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dd class="note">
 
<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>
+
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:
 +
<sqf>skipTime 1; skipTime -1;</sqf>
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
 

Latest revision as of 17:00, 14 May 2022

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 1

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

Syntax 2

Syntax:
setRain rainParams
Parameters:
rainParams: Array - array of custom RainParticles params, see rainParams. Use empty array [] to reset to default config values
Return Value:
Nothing

Syntax 3

Syntax:
setRain config
Parameters:
config: Config - config path to a custom class, which contains RainParticles class. Use configNull to reset to default config values
Return Value:
Nothing

Examples

Example 1:
60 setRain 1;
Example 2:
Force no rain:
Example 3:
Snow like effect (Since Arma 3 v2.08):
0 setOvercast 1; 0 setRain 1; forceWeatherChange; setRain [ "a3\data_f\rainnormal_ca.paa", // rainDropTexture 1, // texDropCount 0.01, // minRainDensity 15, // effectRadius 0.1, // windCoef 2, // dropSpeed 0.5, // rndSpeed 0.5, // rndDir 0.02, // dropWidth 0.02, // dropHeight [0.1, 0.1, 0.1, 1], // dropColor 0.1, // lumSunFront 0.1, // lumSunBack 5.5, // refractCoef 0.3, // refractSaturation true, // snow false // dropColorStrong ];

Additional Information

See also:
rainParams overcast setOvercast rain nextWeatherChange forceWeatherChange setFog setHumidity

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: