asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Merge pull request #89404 from clayjohn/DOCS-bounce-reflect

Browse source 
Clarify bounce and reflect docs and update param names
This commit is contained in:
Rémi Verschelde 2024-04-10 14:21:46 +02:00
commit de1f77c78d
No known key found for this signature in database
GPG key ID: C3336907360768E1
3 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/variant/variant_call.cpp
View file

@ -1799,7 +1799,7 @@ static void _register_variant_builtin_methods() {
bind_method(Vector2, dot, sarray("with"), varray()); bind_method(Vector2, dot, sarray("with"), varray());
bind_method(Vector2, slide, sarray("n"), varray()); bind_method(Vector2, slide, sarray("n"), varray());
bind_method(Vector2, bounce, sarray("n"), varray()); bind_method(Vector2, bounce, sarray("n"), varray());
bind_method(Vector2, reflect, sarray("n"), varray()); bind_method(Vector2, reflect, sarray("line"), varray());
bind_method(Vector2, cross, sarray("with"), varray()); bind_method(Vector2, cross, sarray("with"), varray());
bind_method(Vector2, abs, sarray(), varray()); bind_method(Vector2, abs, sarray(), varray());
bind_method(Vector2, sign, sarray(), varray()); bind_method(Vector2, sign, sarray(), varray());
@ -1896,7 +1896,7 @@ static void _register_variant_builtin_methods() {
bind_method(Vector3, project, sarray("b"), varray()); bind_method(Vector3, project, sarray("b"), varray());
bind_method(Vector3, slide, sarray("n"), varray()); bind_method(Vector3, slide, sarray("n"), varray());
bind_method(Vector3, bounce, sarray("n"), varray()); bind_method(Vector3, bounce, sarray("n"), varray());
bind_method(Vector3, reflect, sarray("n"), varray()); bind_method(Vector3, reflect, sarray("direction"), varray());
bind_method(Vector3, sign, sarray(), varray()); bind_method(Vector3, sign, sarray(), varray());
bind_method(Vector3, octahedron_encode, sarray(), varray()); bind_method(Vector3, octahedron_encode, sarray(), varray());
bind_static_method(Vector3, octahedron_decode, sarray("uv"), varray()); bind_static_method(Vector3, octahedron_decode, sarray("uv"), varray());

8
doc/classes/Vector2.xml
View file

@ -110,7 +110,8 @@
<return type="Vector2" /> <return type="Vector2" />
<param index="0" name="n" type="Vector2" /> <param index="0" name="n" type="Vector2" />
<description> <description>
Returns a new vector "bounced off" from a plane defined by the given normal. Returns the vector "bounced off" from a line defined by the given normal [param n] perpendicular to the line.
[b]Note:[/b] [method bounce] performs the operation that most engines and frameworks call [code skip-lint]reflect()[/code].
</description> </description>
</method> </method>
<method name="ceil" qualifiers="const"> <method name="ceil" qualifiers="const">
@ -321,9 +322,10 @@
</method> </method>
<method name="reflect" qualifiers="const"> <method name="reflect" qualifiers="const">
<return type="Vector2" /> <return type="Vector2" />
<param index="0" name="n" type="Vector2" /> <param index="0" name="line" type="Vector2" />
<description> <description>
Returns the result of reflecting the vector from a line defined by the given direction vector [param n]. Returns the result of reflecting the vector from a line defined by the given direction vector [param line].
[b]Note:[/b] [method reflect] differs from what other engines and frameworks call [code skip-lint]reflect()[/code]. In other engines, [code skip-lint]reflect()[/code] takes a normal direction which is a direction perpendicular to the line. In Godot, you specify the direction of the line directly. See also [method bounce] which does what most engines call [code skip-lint]reflect()[/code].
</description> </description>
</method> </method>
<method name="rotated" qualifiers="const"> <method name="rotated" qualifiers="const">

8
doc/classes/Vector3.xml
View file

@ -86,7 +86,8 @@
<return type="Vector3" /> <return type="Vector3" />
<param index="0" name="n" type="Vector3" /> <param index="0" name="n" type="Vector3" />
<description> <description>
Returns the vector "bounced off" from a plane defined by the given normal. Returns the vector "bounced off" from a plane defined by the given normal [param n].
[b]Note:[/b] [method bounce] performs the operation that most engines and frameworks call [code skip-lint]reflect()[/code].
</description> </description>
</method> </method>
<method name="ceil" qualifiers="const"> <method name="ceil" qualifiers="const">
@ -306,9 +307,10 @@
</method> </method>
<method name="reflect" qualifiers="const"> <method name="reflect" qualifiers="const">
<return type="Vector3" /> <return type="Vector3" />
<param index="0" name="n" type="Vector3" /> <param index="0" name="direction" type="Vector3" />
<description> <description>
Returns the result of reflecting the vector from a plane defined by the given normal [param n]. Returns the result of reflecting the vector from a plane defined by the given direction vector [param direction].
[b]Note:[/b] [method reflect] differs from what other engines and frameworks call [code skip-lint]reflect()[/code]. In other engines, [code skip-lint]reflect()[/code] takes a normal direction which is a direction perpendicular to the plane. In Godot, you specify a direction parallel to the plane. See also [method bounce] which does what most engines call [code skip-lint]reflect()[/code].
</description> </description>
</method> </method>
<method name="rotated" qualifiers="const"> <method name="rotated" qualifiers="const">