mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-03 09:52:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #76049 from timothyqiu/equality

Browse Source 
Unify descriptions of vector methods
This commit is contained in:
Yuri Sizov 2023-04-17 14:05:59 +02:00 committed by GitHub
commit 0f24f015c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/variant/variant_call.cpp
View File

@ -1921,7 +1921,7 @@ static void _register_variant_builtin_methods() {
bind_method(Vector4, distance_squared_to, sarray("to"), varray());
bind_method(Vector4, dot, sarray("with"), varray());
bind_method(Vector4, inverse, sarray(), varray());
bind_method(Vector4, is_equal_approx, sarray("with"), varray());
bind_method(Vector4, is_equal_approx, sarray("to"), varray());
bind_method(Vector4, is_zero_approx, sarray(), varray());
bind_method(Vector4, is_finite, sarray(), varray());

4
doc/classes/Vector2.xml
View File

@ -214,7 +214,7 @@
<return type="bool" />
<param index="0" name="to" type="Vector2" />
<description>
Returns [code]true[/code] if this vector and [code]v[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
Returns [code]true[/code] if this vector and [param to] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="is_finite" qualifiers="const">
@ -288,7 +288,7 @@
<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].
[b]Note:[/b] This function may return incorrect values if the initial vector length is near zero.
[b]Note:[/b] This function may return incorrect values if the input vector length is near zero.
</description>
</method>
<method name="orthogonal" qualifiers="const">

11
doc/classes/Vector4.xml
View File

@ -131,9 +131,9 @@
</method>
<method name="is_equal_approx" qualifiers="const">
<return type="bool" />
<param index="0" name="with" type="Vector4" />
<param index="0" name="to" type="Vector4" />
<description>
Returns [code]true[/code] if this vector and [param with] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
Returns [code]true[/code] if this vector and [param to] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="is_finite" qualifiers="const">
@ -164,7 +164,8 @@
<method name="length_squared" qualifiers="const">
<return type="float" />
<description>
Returns the squared length (squared magnitude) of this vector. This method runs faster than [method length].
Returns the squared length (squared magnitude) of this vector.
This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula.
</description>
</method>
<method name="lerp" qualifiers="const">
@ -198,14 +199,14 @@
<return type="Vector4" />
<param index="0" name="mod" type="float" />
<description>
Returns a new vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param mod].
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param mod].
</description>
</method>
<method name="posmodv" qualifiers="const">
<return type="Vector4" />
<param index="0" name="modv" type="Vector4" />
<description>
Returns a new vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param modv]'s components.
Returns a vector composed of the [method @GlobalScope.fposmod] of this vector's components and [param modv]'s components.
</description>
</method>
<method name="round" qualifiers="const">

3
doc/classes/Vector4i.xml
View File

@ -65,7 +65,8 @@
<method name="length_squared" qualifiers="const">
<return type="int" />
<description>
Returns the squared length (squared magnitude) of this vector. This method runs faster than [method length].
Returns the squared length (squared magnitude) of this vector.
This method runs faster than [method length], so prefer it if you need to compare vectors or need the squared distance for some formula.
</description>
</method>
<method name="max_axis_index" qualifiers="const">