From cca01afd82bd6e7b3e852a66ca459f5d61022585 Mon Sep 17 00:00:00 2001 From: lawnjelly Date: Mon, 13 Mar 2023 12:48:05 +0000 Subject: [PATCH] Improve Vector2 / 3 / 4 normalized() classref. Mention that the results will be unreliable with initial vector near zero. --- doc/classes/Vector2.xml | 1 + doc/classes/Vector3.xml | 1 + doc/classes/Vector4.xml | 1 + 3 files changed, 3 insertions(+) diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 126a68b161c..7be743fb918 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -288,6 +288,7 @@ Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. + [b]Note:[/b] This function may return incorrect values if the initial vector length is near zero. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index f1400b99002..79d25b8091a 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -256,6 +256,7 @@ Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. + [b]Note:[/b] This function may return incorrect values if the input vector length is near zero. diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index 9f2ff338c11..74ae115421b 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -191,6 +191,7 @@ Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. + [b]Note:[/b] This function may return incorrect values if the input vector length is near zero.