getRelPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


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


|gr1= Positions |GROUP1=
|gr1= Positions |GROUP1=
____________________________________________________________________________________________


| Returns position, which is given distance and relative direction away from original object. |DESCRIPTION=
| Returns position, which is given distance and relative direction away from original object. |DESCRIPTION=
____________________________________________________________________________________________


| object '''getRelPos''' [distance, direction]|SYNTAX=
| object '''getRelPos''' [distance, direction]|SYNTAX=
Line 23: Line 20:
| [[Array]] - format [x,y,z], where z is land surface in format [[PositionAGL]] |RETURNVALUE=
| [[Array]] - format [x,y,z], where z is land surface in format [[PositionAGL]] |RETURNVALUE=


____________________________________________________________________________________________
    
    
|x1= Find position 100 metres away at player's 3 o'clock:<code>_relpos = [[player]] [[getRelPos]] [100, 90];</code> |EXAMPLE1=
|x1= Find position 100 metres away at player's 3 o'clock:<code>_relpos = [[player]] [[getRelPos]] [100, 90];</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[getPosASLVisual]], [[getPosATLVisual]], [[visiblePositionASL]], [[visiblePosition]], [[position]], [[getPos]], [[getPosATL]], [[getPosASL]], [[getPosASLW]] |SEEALSO=
| [[getPosASLVisual]], [[getPosATLVisual]], [[visiblePositionASL]], [[visiblePosition]], [[position]], [[getPos]], [[getPosATL]], [[getPosASL]], [[getPosASLW]] |SEEALSO=

Revision as of 02:34, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns position, which is given distance and relative direction away from original object.
Groups:
Positions

Syntax

Syntax:
object getRelPos [distance, direction]
Parameters:
object: Object - object
[distance, direction]: Array
distance: Number - distance from object
direction: Number - direction relative to object's current direction
Return Value:
Array - format [x,y,z], where z is land surface in format PositionAGL

Examples

Example 1:
Find position 100 metres away at player's 3 o'clock:_relpos = player getRelPos [100, 90];

Additional Information

See also:
getPosASLVisualgetPosATLVisualvisiblePositionASLvisiblePositionpositiongetPosgetPosATLgetPosASLgetPosASLW

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

talkingtoaj
getPos vs getRelPos: getRelPos operates similarly to getPos except in getRelPos the direction is calculated 'relative' to the current object direction whereas getPos's direction is from North. Thus while getPos can take a position array as it is starting point, getRelPos requires an object with its own azithmus heading.
Posted on 3 March, 2016

Bottom Section