summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-01-17 11:24:16 +0100
committerGitHub <noreply@github.com>2019-01-17 11:24:16 +0100
commit3b46e99a394d03295869f3b70cfa96fb9c998901 (patch)
treebe54db02e81f3a034745e828c56a25d40a94c5b7 /doc/classes
parenta63bb3c8042846b31c04def2d260e19b2d64d294 (diff)
parent725eb9de8c8fd5ae383af5aab94dc216d55c4c2c (diff)
Merge pull request #25044 from cbscribe/docs_k2d_fix
DOCS: correction to move_and_slide description
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/KinematicBody2D.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml
index 12d2bcec77..986010f832 100644
--- a/doc/classes/KinematicBody2D.xml
+++ b/doc/classes/KinematicBody2D.xml
@@ -94,7 +94,7 @@
[i]TODO: Update for stop_on_slope argument.[/i] If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes.
If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops.
[code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees.
- Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision].
+ Returns the [code]linear_velocity[/code] vector, rotated and/or scaled if a slide collision occurred. To get more detailed information about collisions that occurred, use [method get_slide_collision].
</description>
</method>
<method name="move_and_slide_with_snap">