godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #92707 from GrahameGW/vector_normalized_docs 

Clarify the results of `VectorN.normalized()` in the docs
This commit is contained in:
Rémi Verschelde 2024-06-04 10:10:13 +02:00
parent 62b15238e5 0560e890ca
commit 2f26842d86
No known key found for this signature in database
GPG Key ID: C3336907360768E1
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/Vector2.xml
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>

2
doc/classes/Vector3.xml
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>

2
doc/classes/Vector4.xml
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>