getRelDir: 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 (Added example, removed my note)
 
(28 intermediate revisions by 3 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= Object Manipulation


|gr1= Object Manipulation |GROUP1=
|descr= Returns direction, which is relative to object's current direction, from given object to another object or position in the range from 0 to 360, the equivalent of [[BIS_fnc_relativeDirTo]].
____________________________________________________________________________________________
Taking the current [[direction]] of the object into account.


| Returns direction, which is relative to object's current direction, from given object to another object or position in the range from 0 to 360, the equivalent of [[BIS_fnc_relativeDirTo]]. Taking the current [[direction]] of the object into account. |DESCRIPTION=
|s1= object [[getRelDir]] position
____________________________________________________________________________________________


| object '''getRelDir''' position |SYNTAX=
|p1= object: [[Object]]


|p1= object: [[Object]] |PARAMETER1=
|p2= position: [[Object]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]]
|p2= position: [[Object]], [[Position2D]] or [[Position3D]] |PARAMETER2=
| [[Number]] |RETURNVALUE=
____________________________________________________________________________________________
|x1 = <code>_reldir = [[player]] '''getRelDir''' tank;</code> |EXAMPLE1=
____________________________________________________________________________________________
| [[getDir]], [[direction]], [[getDirVisual]] |SEEALSO=


}}
|r1= [[Number]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_reldir = player getRelDir tank;</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>
</dl>
// Set object's direction towards any given position
_object setDir (getDir _object + (_object getRelDir [_x, _y, _z]))
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[getDir]] [[direction]] [[getDirVisual]]
}}


{{GameCategory|arma3|New Scripting Commands}}
<dl class="command_description">
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<dt></dt>
<dl class="command_description">
<dd class="notedate">Posted on 2018-08-07 - 21:50 (UTC)</dd>
<dd class="notedate">Posted on August 7, 2018 - 21:50 (UTC)</dd>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dt class="note">[[User:Tankbuster|Tankbuster]]</dt>
<dd class="note">
<dd class="note">
To clarify, this returns a relative direction, so objects directly in front are said to be at zero degrees. So, taking example 1 above, if the tank is in front of the player, this function will return 0. If the tank is to the right of the player, it will return 90.
To clarify, this returns a relative direction, so objects directly in front are said to be at zero degrees. So, taking example 1 above, if the tank is in front of the player, this function will return 0. If the tank is to the right of the player, it will return 90.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->

Latest revision as of 04:06, 12 May 2024

Hover & click on the images for description

Description

Description:
Returns direction, which is relative to object's current direction, from given object to another object or position in the range from 0 to 360, the equivalent of BIS_fnc_relativeDirTo. Taking the current direction of the object into account.
Groups:
Object Manipulation

Syntax

Syntax:
object getRelDir position
Parameters:
object: Object
position: Object, Position2D or Position3D
Return Value:
Number

Examples

Example 1:
_reldir = player getRelDir tank;
Example 2:
// Set object's direction towards any given position _object setDir (getDir _object + (_object getRelDir [_x, _y, _z]))

Additional Information

See also:
getDir direction getDirVisual

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
Posted on 2018-08-07 - 21:50 (UTC)
Tankbuster
To clarify, this returns a relative direction, so objects directly in front are said to be at zero degrees. So, taking example 1 above, if the tank is in front of the player, this function will return 0. If the tank is to the right of the player, it will return 90.