setWind: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (forced explained)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *N([a-z ])" to "$1 - n$2")
 
(34 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
|eff= global |= Effects in MP
|version2= 1.50
____________________________________________________________________________________________


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


| '''setWind''' [x, z, forced] |= Syntax
|game4= arma3
|version4= 0.50


|p1= [x, z, forced]: [[Array]] |= PARAMETER1
|gr1= Environment


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


|p3= z: [[Number]] Northerly component (in m/s, positive = to the north) |= PARAMETER3
|descr= Set current or permanent wind vector.
{{Feature | important | The effect is global only if it is executed on the server. Wind set locally will sync back to server value in a while.}}


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


| [[Nothing]] |= RETURNVALUE
|p1= x: [[Number]] - easterly component (in m/s, positive = to the east)


|p2= y: [[Number]] - northerly component (in m/s, positive = to the north)


|x1= <code>'''setWind''' [10, 10, true];</code>|= EXAMPLE
|p4= forced: [[Boolean]] - (Optional, default [[false]]) set to [[true]] to lock the wind to constantly blows in set direction
____________________________________________________________________________________________


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


| mp=Execute on server |= MPBEHAVIOUR
|x1= <sqf>setWind [10, 10, true];</sqf>
____________________________________________________________________________________________
 
|seealso= [[wind]] [[setWindDir]] [[gusts]] [[setGusts]]
}}
}}
<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 ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Environment|{{uc:{{PAGENAME}}}}]]
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]

Latest revision as of 15:39, 8 November 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GEGlobal
Hover & click on the images for description

Description

Description:
Set current or permanent wind vector.
⚠
The effect is global only if it is executed on the server. Wind set locally will sync back to server value in a while.
Groups:
Environment

Syntax

Syntax:
setWind [x, y, forced]
Parameters:
x: Number - easterly component (in m/s, positive = to the east)
y: Number - northerly component (in m/s, positive = to the north)
forced: Boolean - (Optional, default false) set to true to lock the wind to constantly blows in set direction
Return Value:
Nothing

Examples

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

Additional Information

See also:
wind setWindDir gusts setGusts

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=348903"