summaryrefslogtreecommitdiffstats
path: root/doc/classes
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-05-01 09:55:27 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-05-01 09:55:27 +0200
commit4e30bc71f5c7eab6d7dab047cdb95b9db24f9590 (patch)
treedb10f1baf4104e4b8001fc176cc2a616fec2aa0c /doc/classes
parent3ebef6ce7a8dd95f3727e80e0e786b8b0960cced (diff)
parent4d580b15be654c562e56b1cc046c2b1f9992cf0b (diff)
downloadredot-engine-4e30bc71f5c7eab6d7dab047cdb95b9db24f9590.tar.gz
Merge pull request #91376 from clayjohn/DOCS-reflect-vec3
Update the description and parameter name for Vector3 reflect to correct how the plane is constructed
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Vector3.xml6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml
index 031d91af78..acee52dc40 100644
--- a/doc/classes/Vector3.xml
+++ b/doc/classes/Vector3.xml
@@ -307,10 +307,10 @@
</method>
<method name="reflect" qualifiers="const">
<return type="Vector3" />
- <param index="0" name="direction" type="Vector3" />
+ <param index="0" name="n" type="Vector3" />
<description>
- 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].
+ Returns the result of reflecting the vector through a plane defined by the given normal vector [param n].
+ [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] returns the result of the vector reflected by the given plane. The reflection thus passes through the given normal. While in Godot the reflection passes through the plane and can be thought of as bouncing off the normal. See also [method bounce] which does what most engines call [code skip-lint]reflect()[/code].
</description>
</method>
<method name="rotated" qualifiers="const">