Просмотр исходного кода

Improve Vector2.angle() description

(cherry picked from commit a09078e64bf56577f22ab9da7276ee5a82d9dd8c)
Tomasz Chabora 5 лет назад
Родитель
Сommit
5433b8470c
1 измененных файлов с 2 добавлено и 1 удалено
  1. 2 1
      doc/classes/Vector2.xml

+ 2 - 1
doc/classes/Vector2.xml

@@ -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>