diff options
| author | Grahame Watt <watt.grah@gmail.com> | 2024-06-02 16:09:05 -0700 |
|---|---|---|
| committer | Grahame Watt <watt.grah@gmail.com> | 2024-06-03 14:17:12 -0700 |
| commit | 0560e890ca5c2e4f4dea7589eb2c64e8d3472fdc (patch) | |
| tree | 2ccd025cf6df6a5aa31be8d7cd7675244b9e2fa6 | |
| parent | 705b7a0b0bd535c95e4e8fb439f3d84b3fb4f427 (diff) | |
| download | redot-engine-0560e890ca5c2e4f4dea7589eb2c64e8d3472fdc.tar.gz | |
Clarify the results of VectorN.normalized() in the docs
| -rw-r--r-- | doc/classes/Vector2.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Vector3.xml | 2 | ||||
| -rw-r--r-- | doc/classes/Vector4.xml | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 5fadfd0d95..a7df54e880 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -324,7 +324,7 @@ <method name="normalized" qualifiers="const"> <return type="Vector2" /> <description> - Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. + Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. Returns [code](0, 0)[/code] if [code]v.length() == 0[/code]. See also [method is_normalized]. [b]Note:[/b] This function may return incorrect values if the input vector length is near zero. </description> </method> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 387359a97f..1692ba3ece 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -293,7 +293,7 @@ <method name="normalized" qualifiers="const"> <return type="Vector3" /> <description> - Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. + Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. Returns [code](0, 0, 0)[/code] if [code]v.length() == 0[/code]. See also [method is_normalized]. [b]Note:[/b] This function may return incorrect values if the input vector length is near zero. </description> </method> diff --git a/doc/classes/Vector4.xml b/doc/classes/Vector4.xml index 87af370462..f70c59fbef 100644 --- a/doc/classes/Vector4.xml +++ b/doc/classes/Vector4.xml @@ -227,7 +227,7 @@ <method name="normalized" qualifiers="const"> <return type="Vector4" /> <description> - Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. + Returns the result of scaling the vector to unit length. Equivalent to [code]v / v.length()[/code]. Returns [code](0, 0, 0, 0)[/code] if [code]v.length() == 0[/code]. See also [method is_normalized]. [b]Note:[/b] This function may return incorrect values if the input vector length is near zero. </description> </method> |