BIS fnc dirTo: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(70 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/************************************************************
|version4= 0.50
Direction To


Parameters: [object or position 1, object or position 2]
|gr1= Geometry


Returns the compass direction from object/position 1 to
|descr= Function which returns vector direction from pos1 to pos2.
object/position 2. Return is always >=0 <360.
{{Feature|arma3|Use <sqf inline>obj1 getDir obj2</sqf> instead of [[BIS_fnc_dirTo]].}}


Example: [player, getpos dude] call BIS_fnc_dirTo
|s1= [param1, param2] call [[BIS_fnc_dirTo]]
************************************************************/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= param1 - vector starting point, [[Position]] '''or''' [[Object]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_dirTo]]; --> |= Syntax
|p2= param2 - vector ending point, [[Position]] '''or''' [[Object]]


|p1= |= Parameter 1
|r1= [[Number]]


| |= Return value
|x1= sets unit1 in the direction of unit2
____________________________________________________________________________________________
<sqf>unit1 setDir ([unit1, unit2] call BIS_fnc_dirTo);</sqf>


|x1= <code></code> |=
|seealso= [[getDir]] [[setDir]]
____________________________________________________________________________________________
}}
 
| |= See also


{{Note
|user= AgentRev
|timestamp= 20150121142000
|text= Be careful when using this function in conjunction with [[BIS_fnc_rotateVector2D]], which rotates vectors counterclockwise as per trigonometric conventions, while [[BIS_fnc_dirTo]] returns a clockwise angle.<br>
To counter this, simply negate the output of [[BIS_fnc_dirTo]]:
<sqf>[0,1,0], -([_unit, _vehicle] call BIS_fnc_dirTo)] call BIS_fnc_rotateVector2D;</sqf>
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Geometry|{{uc:dirTo}}]]
[[Category:Functions|{{uc:dirTo}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:dirTo}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:dirTo}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:dirTo}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:dirTo}}]]

Latest revision as of 16:37, 13 July 2022

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

Description

Description:
Function which returns vector direction from pos1 to pos2.
Arma 3
Use obj1 getDir obj2 instead of BIS_fnc_dirTo.
Execution:
call
Groups:
Geometry

Syntax

Syntax:
[param1, param2] call BIS_fnc_dirTo
Parameters:
param1 - vector starting point, Position or Object
param2 - vector ending point, Position or Object
Return Value:
Number

Examples

Example 1:
sets unit1 in the direction of unit2
unit1 setDir ([unit1, unit2] call BIS_fnc_dirTo);

Additional Information

See also:
getDir setDir

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
AgentRev - c
Posted on Jan 21, 2015 - 14:20 (UTC)
Be careful when using this function in conjunction with BIS_fnc_rotateVector2D, which rotates vectors counterclockwise as per trigonometric conventions, while BIS_fnc_dirTo returns a clockwise angle.
To counter this, simply negate the output of BIS_fnc_dirTo:
[0,1,0], -([_unit, _vehicle] call BIS_fnc_dirTo)] call BIS_fnc_rotateVector2D;
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_dirTo&oldid=327975"