Difference between revisions of "gestureState"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{RV|type=command |game1= arma3 |version1= 2.06 |branch = dev |arg= global |gr1= Animations |descr= Returns the name of a unit's current gesture. Seems to be forced to lo...")
 
m (Some wiki formatting)
 
(4 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
|game1= arma3
 
|game1= arma3
 
|version1= 2.06
 
|version1= 2.06
 
|branch = dev
 
  
 
|arg= global
 
|arg= global
Line 10: Line 8:
 
|gr1= Animations
 
|gr1= Animations
  
|descr= Returns the name of a unit's current gesture. Seems to be forced to lower case in Arma 3.<br>
+
|descr= Returns the name of a unit's current gesture. Seems to be forced to lower case in {{arma3}}.
{{Feature|Informative|This command is only for a man unit, other units such as animals cannot use this command.}}
+
{{Feature|informative|This command is only for a man unit, other units such as animals cannot use this command.}}
 +
 
 +
|mp= When executed on a client, this command only returns accurate results when the target unit is within sight of the client. When executed on a dedicated server, the returned value is accurate.
  
 
|s1= [[gestureState]] unitName
 
|s1= [[gestureState]] unitName
Line 17: Line 17:
 
|p1= unitName: [[Object]]
 
|p1= unitName: [[Object]]
  
|r1= [[String]] - "" if N/A.
+
|r1= [[String]] - empty string if not available
  
|x1= <code>_state = [[gestureState]] [[player]];</code>
+
|x1= <sqf>private _state = gestureState player;</sqf>
|mp= When executed on a client, this command only returns accurate results when the target unit is within sight of the client. When executed on a dedicated server, the returned value is accurate.
+
 
|seealso= [[switchAction]], [[playAction]], [[BIS_fnc_ambientAnimGetParams]], [[animationState]]
+
|seealso= [[switchAction]] [[playAction]] [[BIS_fnc_ambientAnimGetParams]] [[animationState]]
 
}}
 
}}

Latest revision as of 18:59, 5 May 2022

Hover & click on the images for description

Description

Description:
Returns the name of a unit's current gesture. Seems to be forced to lower case in Arma 3.
This command is only for a man unit, other units such as animals cannot use this command.
Multiplayer:
When executed on a client, this command only returns accurate results when the target unit is within sight of the client. When executed on a dedicated server, the returned value is accurate.
Groups:
Animations

Syntax

Syntax:
gestureState unitName
Parameters:
unitName: Object
Return Value:
String - empty string if not available

Examples

Example 1:

Additional Information

See also:
switchAction playAction BIS_fnc_ambientAnimGetParams animationState

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