diff options
| author | Ferenc Arn <tagcup@yahoo.com> | 2017-03-31 10:25:09 -0500 |
|---|---|---|
| committer | Ferenc Arn <tagcup@yahoo.com> | 2017-04-03 10:02:12 -0500 |
| commit | 1a620bd5faebd83015182ea032f40936a9916af6 (patch) | |
| tree | e1705e3805bae8cb898694136f65d7622dd2bc8c /doc | |
| parent | 6731924dcfa7451d8b31461b438fd2a5aa8af1f6 (diff) | |
Made slide and reflect active verbs acting on itself in Vector2 and Vector3.
This is in alignment with other functions in vector classes.
Also added checks for normalization, fixed the sign of reflect (which now corresponds to reflection along a plane mathematically), added bounce method and updated docs.
Fixes #8201.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index f3d73deaf0..7e4d536299 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -46992,6 +46992,15 @@ do_property]. Returns the ratio of X to Y. </description> </method> + <method name="bounce"> + <return type="Vector2"> + </return> + <argument index="0" name="n" type="Vector2"> + </argument> + <description> + Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + </description> + </method> <method name="clamped"> <return type="Vector2"> </return> @@ -47084,10 +47093,10 @@ do_property]. <method name="reflect"> <return type="Vector2"> </return> - <argument index="0" name="vec" type="Vector2"> + <argument index="0" name="n" type="Vector2"> </argument> <description> - Like "slide", but reflects the Vector instead of continuing along the wall. + Reflects the vector along the given plane, specified by its normal vector. </description> </method> <method name="rotated"> @@ -47102,10 +47111,10 @@ do_property]. <method name="slide"> <return type="Vector2"> </return> - <argument index="0" name="vec" type="Vector2"> + <argument index="0" name="n" type="Vector2"> </argument> <description> - Slides the vector by the other vector. + Slide returns the component of the vector along the given plane, specified by its normal vector. </description> </method> <method name="snapped"> @@ -47178,6 +47187,15 @@ do_property]. <description> </description> </method> + <method name="bounce"> + <return type="Vector3"> + </return> + <argument index="0" name="n" type="Vector3"> + </argument> + <description> + Bounce returns the vector "bounced off" from the given plane, specified by its normal vector. + </description> + </method> <method name="ceil"> <return type="Vector3"> </return> @@ -47308,10 +47326,10 @@ do_property]. <method name="reflect"> <return type="Vector3"> </return> - <argument index="0" name="by" type="Vector3"> + <argument index="0" name="n" type="Vector3"> </argument> <description> - Like "slide", but reflects the Vector instead of continuing along the wall. + Reflects the vector along the given plane, specified by its normal vector. </description> </method> <method name="rotated"> @@ -47328,10 +47346,10 @@ do_property]. <method name="slide"> <return type="Vector3"> </return> - <argument index="0" name="by" type="Vector3"> + <argument index="0" name="n" type="Vector3"> </argument> <description> - Slides the vector along a wall. + Slide returns the component of the vector along the given plane, specified by its normal vector. </description> </method> <method name="snapped"> |