unitPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {2,}\}\}" to " }}")
(Add return values (for casing))
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00


|1.00
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|arg= global
|arg= global
Line 9: Line 20:
|gr1= Unit Control
|gr1= Unit Control


| 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]].


| '''unitPos''' unit
|s1= [[unitPos]] unit


|p1= unit: [[Object]]
|p1= unit: [[Object]]


| [[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.


| [[setUnitPos]], [[setUnitPosWeak]], [[stance]]
|seealso= [[setUnitPos]] [[setUnitPosWeak]] [[stance]] [[pose]]
}}
}}
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 10:38, 11 January 2023

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=unitPos&oldid=337059"