asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve Vector2.angle() description

Browse source 
(cherry picked from commit a09078e64b)
This commit is contained in:
Tomasz Chabora 2020-08-03 22:55:25 +02:00 committed by Rémi Verschelde
parent 0429779835
commit 5433b8470c
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/classes/Vector2.xml
View file

@ -33,7 +33,8 @@
<return type="float">
</return>
<description>
Returns this vector's angle with respect to the X axis, or [code](1, 0)[/code] vector, in radians.
Returns this vector's angle with respect to the positive X axis, or [code](1, 0)[/code] vector, in radians.
For example, [code]Vector2.RIGHT.angle()[/code] will return zero, [code]Vector2.DOWN.angle()[/code] will return [code]PI / 2[/code] (a quarter turn, or 90 degrees), and [code]Vector2(1, -1).angle()[/code] will return [code]-PI / 4[/code] (a negative eighth turn, or -45 degrees).
Equivalent to the result of [method @GDScript.atan2] when called with the vector's [member y] and [member x] as parameters: [code]atan2(y, x)[/code].
</description>
</method>