unitPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
(Add return values (for casing))
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|version2= 1.00


|arg= global|Multiplayer Arguments=
|game3= arma2oa
|version3= 1.50


|gr1= Unit Control |GROUP1=
|game4= tkoh
|version4= 1.00


| Return the unit position rules.
|game5= arma3
|version5= 0.50


<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.
|arg= global
<br>Available modes are listed at [[setUnitPos]]. |DESCRIPTION=


| '''unitPos''' unit |SYNTAX=
|gr1= Unit Control


|p1= unit: [[Object]] |PARAMETER1=
|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]] |RETURNVALUE=
|s1= [[unitPos]] unit


|x1 = <code>[[hint]] [[str]] [[unitPos]] _unit;</code> |EXAMPLE1=
|p1= unit: [[Object]]


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


|mp = Unit pos set by [[setUnitPosWeak]] is not returned for remote (non-local) units.
|x1= <sqf>hint str unitPos _unit;</sqf>


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


|seealso= [[setUnitPos]] [[setUnitPosWeak]] [[stance]] [[pose]]
}}
}}
<h3 style="display:none">Notes</h3>
<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"