setWind: Difference between revisions

Revision as of 13:20, 5 May 2022

1.00

Hover & click on the images for description

Description

Description:: Set current or permanent wind vector.
⚠
The effect is global only if it is executed on the server. Wind set locally will sync back to server value in a while.
Groups:: Environment

Syntax

Syntax:: setWind [x, y, forced]
Parameters:: x: Number - Easterly component (in m/s, positive = to the east)
: y: Number - Northerly component (in m/s, positive = to the north)
: forced: Boolean - (Optional, default false) set to true to lock the wind to constantly blows in set direction
Return Value:: Nothing

Examples

Example 1:: setWind [10, 10, true];

Additional Information

See also:: wind setWindDir gusts setGusts

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma2
+|game1= arma2
-|1.00
+|version1= 1.00
 |game2= arma2oa
@@ Line 17: / Line 17: @@
 |eff= global
-| Set current (forced <nowiki>==</nowiki> false) or permanent (forced <nowiki>==</nowiki> true) wind vector.<br>
+|descr= Set current or permanent wind vector.
-'''NOTE''': The effect is global only if command is executed on the server. Wind set locally will sync back to server value in a while.
+{{Feature | important | The effect is global only if it is executed on the server. Wind set locally will sync back to server value in a while.}}
-| '''setWind''' [x, y, forced]
+|s1= [[setWind]] [x, y, forced]
-|p1= [x, y, forced]: [[Array]]
+|p1= x: [[Number]] - Easterly component (in m/s, positive = to the east)
-|p2= x: [[Number]] Easterly component (in m/s, positive = to the east)
+|p2= y: [[Number]] - Northerly component (in m/s, positive = to the north)
-|p3= y: [[Number]] Northerly component (in m/s, positive = to the north)
+|p4= forced: [[Boolean]] - (Optional, default [[false]]) set to [[true]] to lock the wind to constantly blows in set direction
-|p4= forced: [[Boolean]] true: wind constantly blows in set direction, false: wind can change direction (default)
 |r1= [[Nothing]]
-|x1= <code>'''setWind''' [10, 10, true];</code>|= EXAMPLE
+|x1= <sqf>setWind [10, 10, true];</sqf>
-| [[wind]], [[setWindDir]], [[gusts]], [[setGusts]]
-|mp=Execute on server
+|seealso= [[wind]] [[setWindDir]] [[gusts]] [[setGusts]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}