setLocalWindParams: 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 (Replaced <code> with <sqf>)
 
(31 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= Environment


|gr1= Environment |GROUP1=
|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.


| Sets parameters for helicopter rotor wash. Visually it affects how much the grass, bushes and trees bend and how much the particles blown under a helicopter and how big is the area of the effect. Default [1.0, 1.0].<BR>
|s1= [[setLocalWindParams]] [strength, diameter]
{{Informative|Both parameters can't take 0, it'll just be ignored. If you need to disable effects, put very small values.}} |DESCRIPTION=
____________________________________________________________________________________________


| '''setLocalWindParams''' [strength, diameter] |SYNTAX=
|p1= strength: [[Number]] - down-force wind strength


|p1= [strength, diameter]: [[Array]] |PARAMETER1=
|p2= diameter: [[Number]] - area affected


|p2= strength: [[Number]] - down-force wind strength  |PARAMETER2=
|r1= [[Nothing]]


|p3= diameter: [[Number]]  - area affected |PARAMETER3=
|x1= <sqf>setLocalWindParams [10, 5];</sqf>


| [[Nothing]] |RETURNVALUE=
|x2= "Disables" the effects:
<sqf>setLocalWindParams [0.0001, 0.0001]; // 0 values are ignored by the command</sqf>


|x3= Reset to default:<sqf>setLocalWindParams [1, 1];</sqf>


|x1= <code>[[setLocalWindParams]] [10, 5];</code>|EXAMPLE1=
|seealso= [[setWind]] [[wind]] [[setWindStr]] [[setWindDir]] [[setWindForce]] [[windDir]] [[windStr]] [[gusts]] [[setGusts]]
 
____________________________________________________________________________________________
 
| [[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>
{{GameCategory|arma3|New Scripting Commands List}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}

Latest revision as of 15:53, 14 May 2022

Arma 3 logo black.png0.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
Retrieved from "https://community.bistudio.com/wiki?title=setLocalWindParams&oldid=321461"