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: @@
-[[Category:Scripting Commands|UNITPOS]]
+{{RV|type=command
-[[Category:Scripting Commands ArmA|UNITPOS]]
+|game1= arma1
+|version1= 1.00
+|game2= arma2
+|version2= 1.00
+|game3= arma2oa
+|version3= 1.50
-<h2 style="color:#000066">''''' unitPos''''' ''person''</h2>
+|game4= tkoh
+|version4= 1.00
+|game5= arma3
+|version5= 0.50
-'''Operand types:'''
+|arg= global
-person: [[Object]]
+|gr1= Unit Control
-'''Type of returned value:'''
+|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]].
-[[String]]
+|s1= [[unitPos]] unit
-'''Compatibility:'''
+|p1= unit: [[Object]]
-Version 2.92 required.
+|r1= [[String]] - one of {{hl|"Auto"}}, {{hl|"Up"}}, {{hl|"Middle"}}, {{hl|"Down"}} (as of {{arma3}})
-'''Description:'''
+|x1= <sqf>hint str unitPos _unit;</sqf>
-Return the unit position rules.
+|mp= Unit pos set by [[setUnitPosWeak]] is not returned for remote (non-local) units.
-'''Example:'''
+|seealso= [[setUnitPos]] [[setUnitPosWeak]] [[stance]] [[pose]]
+}}