unitPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|seealso= *\[\[([^ ]+)\]\], \[\[([^ ]+)\]\]" to "|seealso= $1 $2")
(Add return values (for casing))
 
(4 intermediate revisions by the same user not shown)
Line 20: Line 20:
|gr1= Unit Control
|gr1= Unit Control


|descr= Return the unit position rules.
|descr= Return the unit position rules.<br>
 
The return value is always "Auto" unless the unit has gotten a [[setUnitPos]] command. In that case the value is the last stance the unit was ordered to.<br>
<br>The return value is always "Auto" unless the unit has gotten a [[setUnitPos]] command. In that case the value is the last stance the unit was ordered to.
Available modes are listed at [[setUnitPos]].
<br>Available modes are listed at [[setUnitPos]].


|s1= [[unitPos]] unit
|s1= [[unitPos]] unit
Line 29: Line 28:
|p1= unit: [[Object]]
|p1= unit: [[Object]]


|r1= [[String]]
|r1= [[String]] - one of {{hl|"Auto"}}, {{hl|"Up"}}, {{hl|"Middle"}}, {{hl|"Down"}} (as of {{arma3}})


|x1= <code>[[hint]] [[str]] [[unitPos]] _unit;</code>
|x1= <sqf>hint str unitPos _unit;</sqf>


|mp= Unit pos set by [[setUnitPosWeak]] is not returned for remote (non-local) units.
|mp= Unit pos set by [[setUnitPosWeak]] is not returned for remote (non-local) units.

Latest revision as of 10:38, 11 January 2023

Hover & click on the images for description

Description

Description:
Return the unit position rules.
The return value is always "Auto" unless the unit has gotten a setUnitPos command. In that case the value is the last stance the unit was ordered to.
Available modes are listed at setUnitPos.
Multiplayer:
Unit pos set by setUnitPosWeak is not returned for remote (non-local) units.
Groups:
Unit Control

Syntax

Syntax:
unitPos unit
Parameters:
unit: Object
Return Value:
String - one of "Auto", "Up", "Middle", "Down" (as of Arma 3)

Examples

Example 1:
hint str unitPos _unit;

Additional Information

See also:
setUnitPos setUnitPosWeak stance pose

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