setRain: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 31: | 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 the server, the changes will propagate globally. | ||
Minimum [[overcast]] needed for rain in {{arma3}} is '''0.5'''.}} | * if executed on a client, the effect is local, temporary and will soon change to the server setting. | ||
Minimum [[overcast]] needed for rain in {{arma3}} is '''0.5'''. | |||
}} | |||
{{Feature|important|Alternative | {{Feature|important| | ||
Alternative syntaxes ({{Link|#Syntax 2}} and {{Link|#Syntax 3}}): | |||
* set rain particle params. Rain particles params are client-side params and are ignored on dedicated server. Use helper function [[BIS_fnc_setRain]] if sync is needed in Multiplayer | |||
* have a '''[[Multiplayer Scripting#Locality|local]]''' {{Icon|localeffect|32}} effect | |||
}} | |||
|mp= Prior to {{arma3}}, each client and the server could have different rain values. | |mp= Prior to {{arma3}}, each client and the server could have different rain values. | ||
Line 42: | Line 48: | ||
|s1= time [[setRain]] rain | |s1= time [[setRain]] rain | ||
|p1= time: [[Number]] - | |p1= time: [[Number]] - transition time in seconds to the new value | ||
|p2= rain: [[Number]] - | |p2= rain: [[Number]] - new rain value in range 0..1. | ||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
|s2= {{Icon|localeffect|32}} [[setRain]] rainParams | |||
|s2since= arma3 2.08 | |s2since= arma3 2.08 | ||
| | |p21= rainParams: [[Array]] - array of custom [[Arma 3: CfgWorlds Config Reference#class RainParticles | {{hl|RainParticles}}]] params - see [[rainParams]]. Use empty array [] to reset to default config values | ||
|s3= {{Icon|localeffect|32}} [[setRain]] config | |||
|s3since= arma3 2.08 | |s3since= arma3 2.08 | ||
|p41= config: [[Config]] - config path to a custom class, which contains [[Arma 3: CfgWorlds Config Reference#class RainParticles | {{hl|RainParticles}}]] class. Use [[configNull]] to reset to default config values | |||
|x1= <sqf>60 setRain 1;</sqf> | |x1= <sqf>60 setRain 1;</sqf> | ||
|x2= Force no rain: | |x2= Force no rain: | ||
<sqf>0 setRain 0; | <sqf> | ||
0 setRain 0; | |||
forceWeatherChange; | forceWeatherChange; | ||
999999 setRain 0;</sqf> | 999999 setRain 0; | ||
</sqf> | |||
|x3= Snow like effect (Since | |x3= Snow like effect (Since {{arma3}} v2.08): | ||
<sqf>0 setOvercast 1; | <sqf> | ||
0 setOvercast 1; | |||
0 setRain 1; | 0 setRain 1; | ||
0 setFog 0.1; // snow affects visibility at distance | 0 setFog 0.1; // snow affects visibility at distance | ||
Line 89: | Line 101: | ||
true, // snow | true, // snow | ||
false // dropColorStrong | false // dropColorStrong | ||
];</sqf> | ]; | ||
</sqf> | |||
|seealso= [[rainParams]] [[overcast]] [[setOvercast]] [[rain]] [[nextWeatherChange]] [[forceWeatherChange]] [[setFog]] [[setHumidity]] | |seealso= [[rainParams]] [[BIS_fnc_setRain]] [[overcast]] [[setOvercast]] [[rain]] [[nextWeatherChange]] [[forceWeatherChange]] [[setFog]] [[setHumidity]] | ||
}} | }} | ||
{{Note | |||
|user= Zapat | |||
|timestamp= 20151215143100 | |||
|text= [[setTimeMultiplier]] does '''not''' affect transition time. | |||
}} | |||
[[setTimeMultiplier]] does '''not''' affect transition time. | |||
{{Note | |||
|user= Killzone_Kid | |||
|timestamp= 20161116220600 | |||
|text= Using {{Link|#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: | |||
Using | |||
<sqf>skipTime 1; skipTime -1;</sqf> | <sqf>skipTime 1; skipTime -1;</sqf> | ||
}} | |||
Revision as of 23:24, 10 July 2022
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.
- 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..1.
- Return Value:
- Nothing
Syntax 2
- Syntax:
- LELocal 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:
- LELocal 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; 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 BIS_fnc_setRain 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 Dec 15, 2015 - 14:31 (UTC)
- setTimeMultiplier does not affect transition time.
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.75
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Operation Flashpoint: Elite: Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Environment
- Scripting Commands: Global Effect
- Scripting Commands: Server Execution