getDir: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
m (Fix author)
 
(89 intermediate revisions by 17 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#G|COMREF]]
{{RV|type=command


<h2 style="color:#000066"> '''getDir ''obj'''''</h2>
|game1= ofp
|version1= 1.00


|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''obj:''' [[Object]]
|game4= arma2
|version4= 1.00


'''Type of returned value:'''
|game5= arma2oa
|version5= 1.50


[[Number]]
|game6= tkoh
|version6= 1.00


'''Description:'''
|game7= arma3
|version7= 0.50


Object heading in range 0 to 360.
|arg= global


|gr1= Object Manipulation


'''Example:'''
|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]].}}


getDir [[player]]
|s1= [[getDir]] object
 
|p1= object: [[Object]]
 
|r1= [[Number]]
 
|s2= pos1 [[getDir]] pos2
 
|s2since= arma3 1.56
 
|p21= pos1: [[Object]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - from where
 
|p22= pos2: [[Object]], [[Position#Introduction|Position2D]] or [[Position#Introduction|Position3D]] - to where
 
|r2= [[Number]]
 
|x1= <sqf>_azimuth = getDir player;</sqf>
 
|x2= <sqf>_azimuth = player getDir tank;</sqf>
 
|seealso= [[getDirVisual]] [[direction]] [[getRelDir]]
}}
 
{{Note
|user= AgentRev01
|timestamp= 20131023103100
|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>
To counter this, simply negate the output of [[getDir]]:
<sqf>[[0,1,0], -(getDir _object)] call BIS_fnc_rotateVector2D;</sqf>
}}

Latest revision as of 23:14, 4 May 2024

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;