setWind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(sets wind vector in m/s, removed misleading note)
m (Text replacement - "| mp=" to "|mp=")
(23 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
| arma2


|1.00|= Game version
|1.00
____________________________________________________________________________________________


| Set current (forced <nowiki>==</nowiki> false) or permanent (forced <nowiki>==</nowiki> true) wind vector. |= Description
|gr1= Environment
____________________________________________________________________________________________


| '''setWind''' [x, z, forced] |= Syntax
|eff= global


|p1= [x, z, forced]: [[Array]] |= PARAMETER1
| 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.


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


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


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


| [[Nothing]] |= RETURNVALUE
|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)


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


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


| |= MPBEHAVIOUR
| [[wind]], [[setWindDir]], [[gusts]], [[setGusts]]
____________________________________________________________________________________________
 
|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 ArmA2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma2|Scripting Commands}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]

Revision as of 14:24, 25 January 2021

Game1 needed - Version1 needed
GEGlobal
Hover & click on the images for description

Description

Description:
This article is a Stub. You can help BI Community Wiki by expanding it.
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
Retrieved from "https://community.bistudio.com/wiki?title=setWind&oldid=223899"