unitPos: Difference between revisions

Latest revision as of 10:38, 11 January 2023

1.00

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= arma1
+|version1= 1.00
-|1.00|= Game version
+|game2= arma2
-____________________________________________________________________________________________
+|version2= 1.00
-| Return the unit position rules.
+|game3= arma2oa
+|version3= 1.50
-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. |= Description
+|game4= tkoh
-____________________________________________________________________________________________
+|version4= 1.00
-| [[String]] <nowiki>=</nowiki> '''unitPos''' unitName |= Syntax
+|game5= arma3
+|version5= 0.50
-|p1= unitName: [[Object]] |= Parameter 1
+|arg= global
-| [[String]] |= Return value
+|gr1= Unit Control
-____________________________________________________________________________________________
-| [[setUnitPos]], [[setUnitPosWeak]], [[fn_vbs_getUnitPos_(VBS2)|fn_vbs_getUnitPos]] |= See also
+|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]].
-}}
+|s1= [[unitPos]] unit
+|p1= unit: [[Object]]
+|r1= [[String]] - one of {{hl|"Auto"}}, {{hl|"Up"}}, {{hl|"Middle"}}, {{hl|"Down"}} (as of {{arma3}})
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>hint str unitPos _unit;</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|mp= Unit pos set by [[setUnitPosWeak]] is not returned for remote (non-local) units.
-[[Category:Scripting Commands|UNITPOS]]
+|seealso= [[setUnitPos]] [[setUnitPosWeak]] [[stance]] [[pose]]
-[[Category:Scripting Commands ArmA|UNITPOS]]
+}}
-[[Category:Scripting Commands ArmA2|UNITPOS]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]