getRelPos: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "\] +\[" to "] [")
 
(40 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


|arma3|Game name=
|game1= arma3
|version1= 1.56


|1.56|Game version=
|arg= global


|arg= global|Multiplayer Arguments=
|gr1= Positions


|gr1= Positions |GROUP1=
|descr= 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 [[Simulation_vs_Render_Time_Scope#Render_Time_Scope | render scope]].
____________________________________________________________________________________________


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


| object '''getRelPos''' [distance, direction]|SYNTAX=
|p1= object: [[Object]] - object


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


| [[Array]] - format [x,y,z], where z is land surface in format [[PositionAGL]] |RETURNVALUE=
|p4= direction: [[Number]] - direction relative to object's current direction


____________________________________________________________________________________________
|r1= [[Array]] format [[Position#PositionAGL|PositionAGL]]
 
|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=
|s2= obj1 [[getRelPos]] obj2
|s2since= arma3 2.14


}}
|p21= obj1: [[Object]] - parent object


<h3 style="display:none">Notes</h3>
|p22= obj2: [[Object]] - attached object
<dl class="command_description">
<!-- 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 is starting point, getRelPos requires an object with its own azithmus heading.


<dd class="notedate">Posted on 3 March, 2016
|r2= [[Array]] format [[Position#PositionRelative|PositionRelative]]


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


|seealso= [[getPos]] [[getPosASLVisual]] [[getPosATLVisual]] [[visiblePositionASL]] [[visiblePosition]] [[position]] [[getPosATL]] [[getPosASL]] [[getPosASLW]]
}}


<!-- Note Section END -->
{{Note
</dl>
|user= talkingtoaj
 
|timestamp= 20160303155300
<h3 style="display:none">Bottom Section</h3>
|text= [[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.
 
}}
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:46, 5 May 2024

Arma 3 logo black.png1.56
GAGlobal
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.
Retrieved from "https://community.bistudio.com/wiki?title=getRelPos&oldid=364192"