Clarify the results of VectorN.normalized() in the docs

This commit is contained in:
Grahame Watt 2024-06-02 16:09:05 -07:00
parent 705b7a0b0b
commit 0560e890ca
3 changed files with 3 additions and 3 deletions

View file

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

View file

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

View file

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