getRelPos

From Bohemia Interactive Community
Revision as of 14:42, 8 November 2023 by Lou Montana (talk | contribs) (Text replacement - "(\|[pr][0-9]+ *= *[^-\r\n]+) *- *P([a-z])" to "$1 - p$2")
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Returns position that is given distance and relative direction away from original object. The alternative syntax available from Arma 3 v 2.14, returns the position offset of the attached object. If the animated memory point is used for attachment, the offset is calculated in render scope.
Groups:
Positions

Syntax

Syntax:
object getRelPos [distance, direction]
Parameters:
object: Object - object
distance: Number - distance from object
direction: Number - direction relative to object's current direction
Return Value:
Array format PositionAGL

Alternative Syntax

Syntax:
obj1 getRelPos obj2
Parameters:
obj1: Object - parent object
obj2: Object - attached object
Return Value:
Array format PositionRelative

Examples

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

Additional Information

See also:
getPos getPosASLVisual getPosATLVisual visiblePositionASL visiblePosition position getPosATL getPosASL getPosASLW

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
talkingtoaj - c
Posted on Mar 03, 2016 - 15:53 (UTC)
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 azimut heading.