setLocalWindParams: Difference between revisions

Latest revision as of 15:53, 14 May 2022

0.50

Hover & click on the images for description

Description

Description:: Sets parameters for helicopter rotor wash. It affects the visual effect of a rotor's downwash, such as blown particles, vegetation wind effect and area size.
Groups:: Environment

Syntax

Syntax:: setLocalWindParams [strength, diameter]
Parameters:: strength: Number - down-force wind strength
: diameter: Number - area affected
Return Value:: Nothing

Examples

Example 1:: setLocalWindParams [10, 5];
Example 2:: "Disables" the effects:
setLocalWindParams [0.0001, 0.0001]; // 0 values are ignored by the command
Example 3:: Reset to default:
setLocalWindParams [1, 1];

Additional Information

See also:: setWind wind setWindStr setWindDir setWindForce windDir windStr 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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 0.50
-|0.50|= Game version
+|gr1= Environment
-____________________________________________________________________________________________
-| Sets parameters for local wind emiters (like helicopters). Default [1.0, 1.0].  |= Description
+|descr= Sets parameters for helicopter rotor wash.
-____________________________________________________________________________________________
+It affects the visual effect of a rotor's downwash, such as blown particles, vegetation wind effect and area size.
-| '''setLocalWindParams''' [strength, diameter] |= Syntax
+|s1= [[setLocalWindParams]] [strength, diameter]
-|p1= [strength, diameter]: [[Object]]  |= PARAMETER1
+|p1= strength: [[Number]] - down-force wind strength
-|p2= strength: [[Number]]  |= PARAMETER2
+|p2= diameter: [[Number]] - area affected
-|p3= diameter: [[Number]]  |= PARAMETER3
+|r1= [[Nothing]]
-| [[Nothing]] |= RETURNVALUE
+|x1= <sqf>setLocalWindParams [10, 5];</sqf>
+|x2= "Disables" the effects:
+<sqf>setLocalWindParams [0.0001, 0.0001]; // 0 values are ignored by the command</sqf>
-|x1= <code>
+|x3= Reset to default:<sqf>setLocalWindParams [1, 1];</sqf>
-</code>|= EXAMPLE1
-____________________________________________________________________________________________
+|seealso= [[setWind]] [[wind]] [[setWindStr]] [[setWindDir]] [[setWindForce]] [[windDir]] [[windStr]] [[gusts]] [[setGusts]]
-|  |= SEEALSO
-|  |= MPBEHAVIOUR
-____________________________________________________________________________________________
 }}
-<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:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]