rainParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{RV|type=command |game1= arma3 |version1= 2.08 |branch= dev |gr1= Environment |descr= Returns currently set Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | Rain...")
 
m (Some wiki formatting)
 
(11 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 2.08
|version1= 2.08
|branch= dev


|gr1= Environment
|gr1= Environment


|descr= Returns currently set [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]] params, custom or default.
|descr= Returns currently set [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]] params, custom or default.
|mp= {{Feature|important|
* Rain particle params are '''local'''
* If used on a dedicated server, this command returns an empty array.
}}


|s1= [[rainParams]]
|s1= [[rainParams]]


|r1= [[Array]] - [rainDropTexture, texDropCount, minRainDensity, effectRadius, windCoef, dropSpeed, rndSpeed, rndDir, dropWidth, dropHeight, dropColor, lumSunFront, lumSunBack, refractCoef, refractSaturation, snow, dropColorStrong] where:
|r1= [[Array]] - [rainDropTexture, texDropCount, minRainDensity, effectRadius, windCoef, dropSpeed, rndSpeed, rndDir, dropWidth, dropHeight, dropColor, lumSunFront, lumSunBack, refractCoef, refractSaturation, snow, dropColorStrong] where:
<br>* rainDropTexture: [[String]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
{{Columns|4|
<br>* texDropCount: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* rainDropTexture: [[String]]
<br>* minRainDensity: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* texDropCount: [[Number]]
<br>* effectRadius: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* minRainDensity: [[Number]]
<br>* windCoef: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* effectRadius: [[Number]]
<br>* dropSpeed: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* windCoef: [[Number]]
<br>* rndSpeed: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* dropSpeed: [[Number]]
<br>* rndDir: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* rndSpeed: [[Number]]
<br>* dropWidth: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* rndDir: [[Number]]
<br>* dropHeight: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* dropWidth: [[Number]]
<br>* dropColor: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* dropHeight: [[Number]]
<br>* lumSunFront: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* dropColor: [[Array]]
<br>* lumSunBack: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* lumSunFront: [[Number]]
<br>* refractCoef: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* lumSunBack: [[Number]]
<br>* refractSaturation: [[Number]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* refractCoef: [[Number]]
<br>* snow: [[Boolean]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* refractSaturation: [[Number]]
<br>* dropColorStrong: [[Boolean]] - see [[Arma_3:_CfgWorlds_Config_Reference#class_RainParticles | RainParticles]]
* snow: [[Boolean]]
* dropColorStrong: [[Boolean]]
}}
 
{{Feature|informative|See [[Arma 3: CfgWorlds Config Reference#class RainParticles|RainParticles]] for more information.}}


|x1= <code>_rainParams = [[rainParams]];</code>
|x1= <sqf>
private _rainParams = rainParams;
// or
rainParams params [
"_rainDropTexture",
"_texDropCount",
"_minRainDensity",
"_effectRadius",
"_windCoef",
"_dropSpeed",
"_rndSpeed",
"_rndDir",
"_dropWidth",
"_dropHeight",
"_dropColor",
"_lumSunFront",
"_lumSunBack",
"_refractCoef",
"_refractSaturation",
"_snow",
"_dropColorStrong"
];
</sqf>


|seealso= [[setRain]], [[fogParams]], [[overcast]], [[humidity]], [[wind]], [[forceWeatherChange]]
|seealso= [[setRain]] [[fogParams]] [[overcast]] [[humidity]] [[wind]] [[forceWeatherChange]]
}}
}}

Latest revision as of 10:29, 6 May 2024

Arma 3 logo black.png2.08
Hover & click on the images for description

Description

Description:
Returns currently set RainParticles params, custom or default.
Multiplayer:
⚠
  • Rain particle params are local
  • If used on a dedicated server, this command returns an empty array.
Groups:
Environment

Syntax

Syntax:
rainParams
Return Value:
Array - [rainDropTexture, texDropCount, minRainDensity, effectRadius, windCoef, dropSpeed, rndSpeed, rndDir, dropWidth, dropHeight, dropColor, lumSunFront, lumSunBack, refractCoef, refractSaturation, snow, dropColorStrong] where:
ⓘ
See RainParticles for more information.

Examples

Example 1:
private _rainParams = rainParams; // or rainParams params [ "_rainDropTexture", "_texDropCount", "_minRainDensity", "_effectRadius", "_windCoef", "_dropSpeed", "_rndSpeed", "_rndDir", "_dropWidth", "_dropHeight", "_dropColor", "_lumSunFront", "_lumSunBack", "_refractCoef", "_refractSaturation", "_snow", "_dropColorStrong" ];

Additional Information

See also:
setRain fogParams overcast humidity wind forceWeatherChange

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
Retrieved from "https://community.bistudio.com/wiki?title=rainParams&oldid=364216"