BIS fnc position: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatting)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(13 intermediate revisions by the same user not shown)
Line 2: Line 2:


|game1= tkoh
|game1= tkoh
|version1= 1.00
|version1= 1.00


|game2= arma3
|game2= arma3
|version2= 0.50
|version2= 0.50


|gr1= Positions
|gr1= Positions


|descr= Returns [[PositionAGL]], unless passed argument is [[Array]], then the same array is returned. When position is [[Object]] and alternative position is stored in <tt>"BIS_fnc_position_forced"</tt> variable on this object, the stored position is used rather than actual object position. This function is a pretty safe way to get the position of an entity.
|descr= Returns [[Position#PositionAGL|PositionAGL]], unless passed argument is [[Array]], then the same array is returned. When position is [[Object]] and alternative position is stored in {{hl|"BIS_fnc_position_forced"}} variable on this object, the stored position is used rather than actual object position. This function is a pretty safe way to get the position of an entity.


|s1= argument call [[BIS_fnc_position]]
|s1= argument call [[BIS_fnc_position]]


|p1= argument - Could be one of:
|p1= argument - could be one of:
* [[Array]] - Position in format <tt>[x, y]</tt> or <tt>[x, y ,z]</tt>
* [[Array]] - Position in format {{hl|[x, y]}} or {{hl|[x, y ,z]}}
* [[Object]] - Object
* [[Object]] - Object
* [[Group]] - Group, group leader position is used
* [[Group]] - Group, group leader position is used
* [[Location]] - Location
* [[Location]] - Location
* [[String]] - Marker or variable name containing object
* [[String]] - Marker or variable name containing object
{{Feature|Informative|To get the position of an [[Eden Entity]] use {{ic|_entity [[get3DENAttribute]] "Position" [[select]] 0;}}}}
{{Feature|informative|To get the position of an [[Eden Entity]] use <sqf inline>_entity get3DENAttribute "Position" select 0;</sqf>.}}


|r1= [[Array]] - Position in format <tt>[x, y]</tt> or <tt>[x, y ,z]</tt>
|r1= [[Array]] - position in format {{hl|[x, y]}} or {{hl|[x, y ,z]}}


|x1= <code>_pos = [[player]] [[call]] [[BIS_fnc_position]];</code>
|x1= <sqf>private _pos = player call BIS_fnc_position;</sqf>


|seealso= [[Position]]
|seealso= [[Position]]
}}
}}

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description

Description:
Returns PositionAGL, unless passed argument is Array, then the same array is returned. When position is Object and alternative position is stored in "BIS_fnc_position_forced" variable on this object, the stored position is used rather than actual object position. This function is a pretty safe way to get the position of an entity.
Execution:
call
Groups:
Positions

Syntax

Syntax:
argument call BIS_fnc_position
Parameters:
argument - could be one of:
  • Array - Position in format [x, y] or [x, y ,z]
  • Object - Object
  • Group - Group, group leader position is used
  • Location - Location
  • String - Marker or variable name containing object
To get the position of an Eden Entity use _entity get3DENAttribute "Position" select 0;.
Return Value:
Array - position in format [x, y] or [x, y ,z]

Examples

Example 1:
private _pos = player call BIS_fnc_position;

Additional Information

See also:
Position

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