Difference between revisions of "Osiris/API/GetAngleTo"

From Divinity Engine Wiki
Jump to: navigation, search
(Documented GetAngleTo)
 
m
Line 2: Line 2:
 
* query '''GetAngleTo'''('''''[in]'''(REAL)'''''_x0''', '''''[in]'''(REAL)'''''_z0''', '''''[in]'''(REAL)'''''_x1''', '''''[in]'''(REAL)'''''_z1''', '''''[out]'''(INTEGER)'''''_Angle''')
 
* query '''GetAngleTo'''('''''[in]'''(REAL)'''''_x0''', '''''[in]'''(REAL)'''''_z0''', '''''[in]'''(REAL)'''''_x1''', '''''[in]'''(REAL)'''''_z1''', '''''[out]'''(INTEGER)'''''_Angle''')
 
===== Description =====
 
===== Description =====
Returns the angle between two points in degrees.
+
Returns the angle around the Y-axis between two points in degrees.
 
===== Return Values =====
 
===== Return Values =====
 
* '''Success/Failure''': Always succeeds.
 
* '''Success/Failure''': Always succeeds.
* '''_Angle''': The angle between ('''_x0, '''_z0''') and ('''x1''', '''z1''') in degrees.
+
* '''_Angle''': The angle between ('''_x0''', '''_z0''') and ('''x1''', '''z1''') around the Y-axis in degrees.
 
===== Notes =====
 
===== Notes =====
 
* The returned angle is in the interval [-180, 180].
 
* The returned angle is in the interval [-180, 180].

Revision as of 14:54, 31 January 2018

Full Definition(s)
  • query GetAngleTo([in](REAL)_x0, [in](REAL)_z0, [in](REAL)_x1, [in](REAL)_z1, [out](INTEGER)_Angle)
Description

Returns the angle around the Y-axis between two points in degrees.

Return Values
  • Success/Failure: Always succeeds.
  • _Angle: The angle between (_x0, _z0) and (x1, z1) around the Y-axis in degrees.
Notes
  • The returned angle is in the interval [-180, 180].
See Also