setRain: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dd class="notedate">" to "<dl class="command_description"> <dt></dt> <dd class="notedate">")
No edit summary
(39 intermediate revisions by 4 users not shown)
Line 2: Line 2:


|game1= ofp
|game1= ofp
|version1= 1.75
|version1= 1.75


|game2= ofpe
|game2= ofpe
|version2= 1.00
|version2= 1.00


|game3= arma1
|game3= arma1
|version3= 1.00
|version3= 1.00


|game4= arma2
|game4= arma2
|version4= 1.00
|version4= 1.00


|game5= arma2oa
|game5= arma2oa
 
|version5= 1.50
|version5= 1.51


|game6= tkoh
|game6= tkoh
|version6= 1.00
|version6= 1.00


|game7= arma3
|game7= arma3
|version7= 0.50
|version7= 0.50


Line 38: Line 31:
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 multiplayer 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.
Line 52: Line 45:


|r1= [[Nothing]]
|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]]
|s2= [[setRain]] rainParams
|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
|s2since= arma3 2.08
 
|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>
 
|x2= Force no rain:
<sqf>0 setRain 0;
forceWeatherChange;
999999 setRain 0;</sqf>
 
|x3= Snow like effect (Since Arma 3 v2.08):
<sqf>0 setOvercast 1;
0 setRain 1;
0 setFog 0.1; // snow affects visibility at distance
setHumidity 0.9; // don't want to see dust clouds
enableEnvironment [false, true]; // don't want to see snakes and butterflies either
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>
 
|seealso= [[rainParams]] [[overcast]] [[setOvercast]] [[rain]] [[nextWeatherChange]] [[forceWeatherChange]] [[setFog]] [[setHumidity]]
}}
}}


<dl class="command_description">
<dl class="command_description">
<dt></dt>
<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>
Line 70: Line 101:
</dd>
</dd>


<dt><dt>
<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>

Revision as of 13:01, 24 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:
0 setRain 0; forceWeatherChange; 999999 setRain 0;
Example 3:
Snow like effect (Since Arma 3 v2.08):
0 setOvercast 1; 0 setRain 1; 0 setFog 0.1; // snow affects visibility at distance setHumidity 0.9; // don't want to see dust clouds enableEnvironment [false, true]; // don't want to see snakes and butterflies either 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: