setWind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "| mp=" to "|mp=")
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
| arma2


|1.00|Game version=
|1.00


|gr1= Environment |GROUP1=
|gr1= Environment


 
|eff= global
|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.
____________________________________________________________________________________________


| '''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
____________________________________________________________________________________________
}}
}}


<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]

Revision as of 14:24, 25 January 2021

Hover & click on the images for description

Description

Description:
Description needed
Multiplayer:
Execute on server
Groups:
Environment

Syntax

Syntax:
Syntax needed
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:
Return value needed

Examples

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

Additional Information

See also:
See also needed

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