summaryrefslogtreecommitdiffstats
path: root/doc/classes/Vector3.xml
diff options
context:
space:
mode:
authorclayjohn <claynjohn@gmail.com>2024-04-30 13:50:39 -0700
committerclayjohn <claynjohn@gmail.com>2024-04-30 13:50:39 -0700
commit4d580b15be654c562e56b1cc046c2b1f9992cf0b (patch)
tree2d7eafb2a6ee6cc778af6c0e50715e803141d7c5 /doc/classes/Vector3.xml
parent89850d553eeb259e208d0c577cd7bc1eabd3a90a (diff)
downloadredot-engine-4d580b15be654c562e56b1cc046c2b1f9992cf0b.tar.gz
Update the description and parameter name for Vector3 reflect to correct how the plane is constructed
Diffstat (limited to 'doc/classes/Vector3.xml')
-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">