setWind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(x,z -> x,y)
m (template:command argument fix)
Line 14: Line 14:
| '''setWind''' [x, y, forced] |= Syntax
| '''setWind''' [x, y, forced] |= Syntax


|p1= [x, y, forced]: [[Array]] |= PARAMETER1
|p1= [x, y, forced]: [[Array]] |PARAMETER1=  


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


|p3= y: [[Number]] Northerly component (in m/s, positive = to the north) |= PARAMETER3
|p3= y: [[Number]] Northerly component (in m/s, positive = to the north) |PARAMETER3=  


|p4= forced: [[Boolean]] true: wind constantly blows in set direction, false: wind can change direction (default) |= PARAMETER4
|p4= forced: [[Boolean]] true: wind constantly blows in set direction, false: wind can change direction (default) |PARAMETER4=  


| [[Nothing]] |= RETURNVALUE
| [[Nothing]] |RETURNVALUE=  




Line 28: Line 28:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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

Revision as of 10:37, 7 April 2019

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:
Uncategorised

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