setWind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma2 |Game name=
| arma2 |Game name=
Line 10: Line 9:


|eff= global |Multiplayer Effects=
|eff= global |Multiplayer Effects=
____________________________________________________________________________________________


| Set current (forced <nowiki>==</nowiki> false) or permanent (forced <nowiki>==</nowiki> true) wind vector.<br>
| Set current (forced <nowiki>==</nowiki> false) or permanent (forced <nowiki>==</nowiki> true) wind vector.<br>
'''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. |DESCRIPTION=
'''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. |DESCRIPTION=
____________________________________________________________________________________________


| '''setWind''' [x, y, forced] |SYNTAX=
| '''setWind''' [x, y, forced] |SYNTAX=
Line 30: Line 27:


|x1= <code>'''setWind''' [10, 10, true];</code>|= EXAMPLE
|x1= <code>'''setWind''' [10, 10, true];</code>|= EXAMPLE
____________________________________________________________________________________________


| [[wind]], [[setWindDir]], [[gusts]], [[setGusts]] |SEEALSO=  
| [[wind]], [[setWindDir]], [[gusts]], [[setGusts]] |SEEALSO=  


| mp=Execute on server |MPBEHAVIOUR=  
| mp=Execute on server |MPBEHAVIOUR=  
____________________________________________________________________________________________
}}
}}



Revision as of 03:58, 17 January 2021

Hover & click on the images for description

Description

Description:
Set current (forced == false) or permanent (forced == true) 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.
Multiplayer:
Execute on server
Groups:
Environment

Syntax

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 true: wind constantly blows in set direction, false: wind can change direction (default)
Return Value:
Nothing

Examples

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

Additional Information

See also:
windsetWindDirgustssetGusts

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

Notes

Bottom Section