BIS fnc position: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(description, syntax)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
|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. |= Description
 
Description:
Return position
 
Parameter(s):
_this:
ARRAY - position in format [x,y] or [x,y,z]
OBJECT - object
GROUP - group leader
LOCATION - location
STRING - marker
CODE - result of code
 
Returns:
ARRAY - position in format [x,y] or [x,y,z]
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_position]]; --> |= Syntax
| argument call [[BIS_fnc_position]]|= Syntax


|p1= |= Parameter 1
|p1= argument - could be one of:
<span>
* [[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
</span>|= Parameter 1


| |= Return value
| [[Array]] - position in format [x,y] or [x,y,z]|= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


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



Revision as of 01:53, 12 March 2017


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.
Execution:
call
Groups:
Uncategorised

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
Return Value:
Array - position in format [x,y] or [x,y,z]

Examples

Example 1:
_pos = player call BIS_fnc_position;

Additional Information

See also:
See also needed

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