setWind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *N([a-z ])" to "$1 - n$2")
 
(2 intermediate revisions by the same user not shown)
Line 22: Line 22:
|s1= [[setWind]] [x, y, forced]
|s1= [[setWind]] [x, y, forced]


|p1= x: [[Number]] - Easterly component (in m/s, positive = to the east)
|p1= x: [[Number]] - easterly component (in m/s, positive = to the east)


|p2= y: [[Number]] - Northerly component (in m/s, positive = to the north)
|p2= 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]] - (Optional, default [[false]]) set to [[true]] to lock the wind to constantly blows in set direction
Line 30: Line 30:
|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[setWind]] [10, 10, true];</code>
|x1= <sqf>setWind [10, 10, true];</sqf>


|seealso= [[wind]] [[setWindDir]] [[gusts]] [[setGusts]]
|seealso= [[wind]] [[setWindDir]] [[gusts]] [[setGusts]]
}}
}}

Latest revision as of 15:39, 8 November 2023

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 or on the Forums.
Only post proven facts here! Add Note