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 "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame( +[0-9])?|Game [Vv]ersion( +[0-9])?|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|MP[Aa]rg|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|arg= global|Multiplayer Arguments=
|arg= global


|gr1= Unit Control |GROUP1=
|gr1= Unit Control


| Return the unit position rules.
| 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>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]]. |DESCRIPTION=
<br>Available modes are listed at [[setUnitPos]].


| '''unitPos''' unit |SYNTAX=
| '''unitPos''' unit


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


| [[String]] |RETURNVALUE=
| [[String]]


|x1 = <code>[[hint]] [[str]] [[unitPos]] _unit;</code> |EXAMPLE1=
|x1 = <code>[[hint]] [[str]] [[unitPos]] _unit;</code>




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


}}
}}

Revision as of 12:42, 18 January 2021

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

Examples

Example 1:
hint str unitPos _unit;

Additional Information

See also:
setUnitPossetUnitPosWeakstance

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

Notes