unitPos: Difference between revisions

Latest revision as of 10:38, 11 January 2023

Hover & click on the images for 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:: unitPos unit
Parameters:: unit: Object
Return Value:: String - one of "Auto", "Up", "Middle", "Down" (as of Arma 3)

: 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: @@
 {{RV|type=command
-| arma1
+|game1= arma1
-|1.00
+|version1= 1.00
 |game2= arma2
@@ Line 20: / Line 20: @@
 |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>
+Available modes are listed at [[setUnitPos]].
-<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.
+|s1= [[unitPos]] unit
-<br>Available modes are listed at [[setUnitPos]].
-|s1=  '''unitPos''' unit
 |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.
-|seealso= [[setUnitPos]], [[setUnitPosWeak]], [[stance]]
+|seealso= [[setUnitPos]] [[setUnitPosWeak]] [[stance]] [[pose]]
 }}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}