unitPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| arma1 |Game name=
| arma1 |Game name=
Line 9: Line 8:


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


| Return the unit position rules.
| Return the unit position rules.
Line 15: Line 13:
<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]]. |DESCRIPTION=
____________________________________________________________________________________________


| '''unitPos''' unit |SYNTAX=
| '''unitPos''' unit |SYNTAX=
Line 22: Line 19:


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


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


____________________________________________________________________________________________


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

Revision as of 05:14, 17 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

Bottom Section