setWind: Difference between revisions

Revision as of 09:48, 11 June 2021

Hover & click on the images for description

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

Syntax:: setWind [x, y, forced]
Parameters:: [x, y, forced]: Array
: 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

: 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

@@ 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 command 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]]
@@ Line 28: / Line 28: @@
 |p3= y: [[Number]] Northerly component (in m/s, positive = to the north)
-|p4= forced: [[Boolean]] true: wind constantly blows in set direction, false: wind can change direction (default)
+|p4= forced: [[Boolean]] - (Optional, default [[false]]) set to [[true]] to lock the wind to constantly blows in set direction
 |r1= [[Nothing]]
-|x1= <code>'''setWind''' [10, 10, true];</code>|= EXAMPLE
+|x1= <code>[[setWind]] [10, 10, true];</code>
 |seealso= [[wind]], [[setWindDir]], [[gusts]], [[setGusts]]
-|mp=Execute on server
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}