From 5433b8470c8c06b372704e92c87d8476f7e97ea3 Mon Sep 17 00:00:00 2001 From: Tomasz Chabora Date: Mon, 3 Aug 2020 22:55:25 +0200 Subject: [PATCH] Improve Vector2.angle() description (cherry picked from commit a09078e64bf56577f22ab9da7276ee5a82d9dd8c) --- doc/classes/Vector2.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 6ea12c6965d..26f8d721bc8 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -33,7 +33,8 @@ - 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].