position: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(72 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1=  


|1.5|= Game version
|game2= arma1
____________________________________________________________________________________________
|version2= 1.00


| Returns an object's or (in [[ArmA]] 1.08 onwards) location's position. If using a [[Location|location]] that is attached to an object, the location's set or created position is returned rather than object's position.|= Description
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| [[Position]] <nowiki>=</nowiki> '''position''' ObjectOrLocation|= Syntax
|game4= arma2oa
|version4= 1.50


|p1= ObjectOrLocation: An [[Object]] or [[Location]] |= Parameter 1
|game5= tkoh
|version5= 1.00


| [[Position]]|= Return value
|game6= arma3
____________________________________________________________________________________________
|version6= 0.50
 
|x1= <code>_Pos<nowiki> =</nowiki> position [[player]]</code> |= Example 1
|x2= <code>_myLocationHomePos<nowiki> =</nowiki> position myLocation</code> |= Example 2
____________________________________________________________________________________________


| [[locationPosition]], [[getPos]] |= See also
|gr1= Positions


}}
|descr= Returns position of an object (alias of [[getPos]]) or location (alias of [[locationPosition]]).
{{Feature|important|Do '''not''' use this command to get an object's position in 3D. See [[getPos]] for an explanation and alternatives.}}
|s1= [[position]] object
 
|p1= object: [[Object]]
 
|r1= [[Array]] format [[Position#PositionAGLS|PositionAGLS]]
 
|s2= [[position]] location
 
|p21= location: [[Location]]
 
|r2= [[Array]] format [[Position#PositionAGL|PositionAGL]] - see [[locationPosition]]
{{Feature|important|This position is the location's position '''regardless of [[attachObject]] usage''' - see {{Link|#Example 3}}.}}
 
|x1= <sqf>private _pos = position player;</sqf>


<h3 style="display:none">Notes</h3>
|x2= <sqf>_myLocationHomePos = position myLocation;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x3= <sqf>
</dl>
private _location = createLocation ["b_inf", [1000, 1000], 1, 1];
_location attachObject player;
locationPosition _location; // [1916.03,5711.98,12.208]
getPos _location; // [1916.03,5711.98,12.208]
position _location; // [1000,1000,0]
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[getPos]] [[getPosATL]] [[getPosASL]] [[getPosASLW]] [[visiblePosition]] [[getPosVisual]] [[visiblePositionASL]] [[locationPosition]]
[[Category:Scripting Commands|POSITION]]
}}
[[Category:Scripting Commands OFP 1.96|POSITION]]
[[Category:Scripting Commands ArmA|POSITION]]

Latest revision as of 21:32, 28 September 2023

Hover & click on the images for description

Description

Description:
Returns position of an object (alias of getPos) or location (alias of locationPosition).
Do not use this command to get an object's position in 3D. See getPos for an explanation and alternatives.
Groups:
Positions

Syntax

Syntax:
position object
Parameters:
object: Object
Return Value:
Array format PositionAGLS

Alternative Syntax

Syntax:
position location
Parameters:
location: Location
Return Value:
Array format PositionAGL - see locationPosition
This position is the location's position regardless of attachObject usage - see Example 3.

Examples

Example 1:
private _pos = position player;
Example 2:
_myLocationHomePos = position myLocation;
Example 3:
private _location = createLocation ["b_inf", [1000, 1000], 1, 1]; _location attachObject player; locationPosition _location; // [1916.03,5711.98,12.208] getPos _location; // [1916.03,5711.98,12.208] position _location; // [1000,1000,0]

Additional Information

See also:
getPos getPosATL getPosASL getPosASLW visiblePosition getPosVisual visiblePositionASL locationPosition

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