getWeaponSway: Difference between revisions

From Bohemia Interactive Community
m (template:command argument fix)
m (description)
 
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|=
{{RV|type=command
____________________________________________________________________________________________
 
|arma3 |= Game
|game1= arma3
|1.62|= Game Version
|version1= 1.62
|arg=  |= Multiplayer Arguments
 
|eff= |= Multiplayer Effects
|gr1= Stamina System
____________________________________________________________________________________________
 
| Returns current size of weapon sway of a given unit, in radians |DESCRIPTION=
|gr2= Weapons
____________________________________________________________________________________________
 
| [[getWeaponSway]] unit |SYNTAX=
|descr= Returns current size of weapon sway of a given unit, in [[rad|radians]]. This command may still return a value greater 0 even if sway was effectively set to 0 with <sqf inline>player setCustomAimCoef 0;</sqf>.
|p1= unit: [[Object]] |PARAMETER1=
 
|p2=  |PARAMETER2=
|s1= [[getWeaponSway]] unit
|p3=  |PARAMETER3=
 
|p3=  |PARAMETER4=
|p1= unit: [[Object]]
|p3=  |PARAMETER5=
|p3=  |PARAMETER6=
| [[Number]]: weapon sway |RETURNVALUE=
|x1= _sway = [[getWeaponSway]] [[player]]; |EXAMPLE1=
| - |SEEALSO=
}}


<dl class='command_description'>
|r1= [[Number]] - weapon sway
<!-- BEGIN Note Section -->
<!-- For example:
<dd class='notedate'>Posted on Month Day, Year - Time (UTC)</dd>
<dt class='note'>'''[[User:User Name|User Name]]'''</dt>
<dd class='note'>This is an example note. It is true and verifiable, and contains a little code snippet.
<code>[[if]] ([[_this]] == anExample) [[then]] { hint: Leave it here for others to read; };</code></dd>
-->
<!-- END Note Section -->
</dl>


<h3 style='display:none'>Bottom Section</h3>
|x1= <sqf>_sway = getWeaponSway player;</sqf>
<!-- Appropriate categories go here -->


[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|seealso= [[weaponInertia]] [[getCustomAimCoef]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
}}

Latest revision as of 16:00, 15 September 2025

Arma 3 logo black.png 1.62
Hover & click on the images for description

Description

Description:
Returns current size of weapon sway of a given unit, in radians. This command may still return a value greater 0 even if sway was effectively set to 0 with player setCustomAimCoef 0;.
Groups:
Stamina SystemWeapons

Syntax

Syntax:
getWeaponSway unit
Parameters:
unit: Object
Return Value:
Number - weapon sway

Examples

Example 1:
_sway = getWeaponSway player;

Additional Information

See also:
weaponInertia getCustomAimCoef

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=getWeaponSway&oldid=376211"