setWind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Environment |GROUP1=
|gr1= Environment




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


| 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.


| '''setWind''' [x, y, forced] |SYNTAX=
| '''setWind''' [x, y, forced]


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


|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)


|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)


|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)


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




|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]]


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



Revision as of 11:25, 18 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