getDir: Difference between revisions

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


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|arg= global |Multiplayer Arguments=
|game3= arma1
|version3= 1.00


|gr1= Object Manipulation |GROUP1=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| Returns the object heading in the range 0..360.
|game5= arma2oa
|version5= 1.50


{{Feature|arma3 | An alternative syntax was added that gets heading from one object or position to another object or position, the engine equivalent of [[BIS_fnc_dirTo]].}} |DESCRIPTION=
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00


| [[getDir]] object |SYNTAX=
|game7= arma3
|version7= 0.50


|p1= object: [[Object]] |PARAMETER1=
|arg= global


| [[Number]] |RETURNVALUE=
|gr1= Object Manipulation
____________________________________________________________________________________________


| s2= pos1 [[getDir]] pos2 {{since|arma3|1.55.133361}} |SYNTAX2=
|descr= Returns the object heading in the range 0..360.
{{Feature|arma3|The alternative syntax gets heading from one object or position to another object or position, and should be used instead of [[BIS_fnc_dirTo]].}}


|p21= pos1: [[Object]], [[Position2D]] or [[Position3D]] - from where |PARAMETER21=
|s1= [[getDir]] object


|p22= pos2: [[Object]], [[Position2D]] or [[Position3D]] - to where |PARAMETER22=
|p1= object: [[Object]]


| r2= [[Number]] |RETURNVALUE2=
|r1= [[Number]]
____________________________________________________________________________________________


|x1 = <code>_azimuth = [[getDir]] [[player]];</code> |EXAMPLE1=
|s2= pos1 [[getDir]] pos2


|x2 = <code>_azimuth = [[player]] [[getDir]] tank;</code> |EXAMPLE2=
|s2since= arma3 1.56
____________________________________________________________________________________________


| [[getDirVisual]], [[direction]], [[getRelDir]] |SEEALSO=
|p21= pos1: [[Object]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - from where
}}
 
|p22= pos2: [[Object]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - to where


<h3 style="display:none">Notes</h3>
|r2= [[Number]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on October 23, 2013
|x1= <sqf>_azimuth = getDir player;</sqf>
<dt class="note">[[User:AgentRev|AgentRev]]
<dd class="note">
Be careful when using this command in conjunction with [[BIS_fnc_rotateVector2D]], which rotates vectors counterclockwise as per trigonometric conventions, while [[getDir]] returns a clockwise angle.
<br>
To counter this, simply negate the output of [[getDir]]:


<code>[[0,1,0], '''-('''[[getDir]] _object''')'''] [[call]] [[BIS_fnc_rotateVector2D]];</code>
|x2= <sqf>_azimuth = player getDir tank;</sqf>


<!-- Note Section END -->
|seealso= [[getDirVisual]] [[direction]] [[getRelDir]]
</dl>
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|user= AgentRev01
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
|timestamp= 20131023103100
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
|text= Be careful when using this command in conjunction with [[BIS_fnc_rotateVector2D]], which rotates vectors counterclockwise as per trigonometric conventions, while [[getDir]] returns a clockwise angle.<br>
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
To counter this, simply negate the output of [[getDir]]:
{{GameCategory|arma1|Scripting Commands}}
<sqf>[[0,1,0], -(getDir _object)] call BIS_fnc_rotateVector2D;</sqf>
{{GameCategory|arma2|Scripting Commands}}
}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 23:14, 4 May 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
Returns the object heading in the range 0..360.
Arma 3
The alternative syntax gets heading from one object or position to another object or position, and should be used instead of BIS_fnc_dirTo.
Groups:
Object Manipulation

Syntax

Syntax:
getDir object
Parameters:
object: Object
Return Value:
Number

Alternative Syntax

Syntax:
pos1 getDir pos2
Parameters:
pos1: Object, Position2D or Position3D - from where
pos2: Object, Position2D or Position3D - to where
Return Value:
Number

Examples

Example 1:
_azimuth = getDir player;
Example 2:
_azimuth = player getDir tank;

Additional Information

See also:
getDirVisual direction getRelDir

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
AgentRev01 - c
Posted on Oct 23, 2013 - 10:31 (UTC)
Be careful when using this command in conjunction with BIS_fnc_rotateVector2D, which rotates vectors counterclockwise as per trigonometric conventions, while getDir returns a clockwise angle.
To counter this, simply negate the output of getDir:
[[0,1,0], -(getDir _object)] call BIS_fnc_rotateVector2D;
Retrieved from "https://community.bistudio.com/wiki?title=getDir&oldid=364132"