getRelPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "|= Game name" to "|Game name=")
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{Command|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3dev |= Game name
|arma3|Game name=
|1.55|= Game version
 
|arg= global|= Arguments in MP
|1.56|Game version=
 
|arg= global|Multiplayer Arguments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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=


|p1= object: [[Object]] - object |= Parameter 1
|p1= object: [[Object]] - object |PARAMETER1=
|p2= [distance, direction]: [[Array]] |= Parameter 2
|p2= [distance, direction]: [[Array]] |PARAMETER2=
|p3= distance: [[Number]] - distance from object |= Parameter 3
|p3= distance: [[Number]] - distance from object |PARAMETER3=
|p4= direction: [[Number]] - direction relative to object's current direction |= Parameter 4
|p4= direction: [[Number]] - direction relative to object's current direction |PARAMETER4=


| [[Array]] - format [x,y,z], where z is land surface in format [[PositionAGL]] |= Return value
| [[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> |= Example 1
|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]] |= See also
| [[getPosASLVisual]], [[getPosATLVisual]], [[visiblePositionASL]], [[visiblePosition]], [[position]], [[getPos]], [[getPosATL]], [[getPosASL]], [[getPosASLW]] |SEEALSO=


}}
}}
Line 31: Line 33:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dt class="note">'''[[User:talkingtoaj|talkingtoaj]]'''<dd class="note">
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's starting point, getRelPos requires an object with its own azithmus heading.
<dd class="notedate">Posted on 3 March, 2016
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>

Revision as of 22:04, 31 August 2019

Hover & click on the images for description

Description

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

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's starting point, getRelPos requires an object with its own azithmus heading.
Posted on 3 March, 2016

Bottom Section