setWind: Difference between revisions

From Bohemia Interactive Community
mNo edit summary
m (Text replacement - "<code>\[\[([a-zA-Z0-9_]+)\]\] +(\[[a-zA-Z0-9_, ]+\]);?<\/code>" to "<sqf>$1 $2;</sqf>")
(4 intermediate revisions by the same user not shown)
Line 18: Line 18:


|descr= Set current or permanent wind vector.
|descr= Set current or permanent wind vector.
{{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.}}
{{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.}}


|s1= [[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]] - (Optional, default [[false]]) set to [[true]] to lock the wind to constantly blows in set direction
Line 32: 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]]
}}
}}

Revision as of 13:20, 5 May 2022

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