diff options
Diffstat (limited to 'doc/classes/KinematicBody2D.xml')
| -rw-r--r-- | doc/classes/KinematicBody2D.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index cdb1b0aa68..e48660a889 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -81,7 +81,7 @@ </argument> <argument index="2" name="infinite_inertia" type="bool" default="true"> </argument> - <argument index="3" name="slope_stop_min_velocity" type="float" default="5"> + <argument index="3" name="stop_on_slope" type="bool" default="false"> </argument> <argument index="4" name="max_bounces" type="int" default="4"> </argument> @@ -91,7 +91,7 @@ Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody2D[/code] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector2(0, 0)[/code], everything is considered a wall. This is useful for topdown games. - 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. + [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_bounces[/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]. @@ -108,14 +108,14 @@ </argument> <argument index="3" name="infinite_inertia" type="bool" default="true"> </argument> - <argument index="4" name="slope_stop_min_velocity" type="float" default="5"> + <argument index="4" name="stop_on_slope" type="bool" default="false"> </argument> <argument index="5" name="max_bounces" type="int" default="4"> </argument> <argument index="6" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> - Moves the body while keeping it attached to slopes. Similar to [me + Moves the body while keeping it attached to slopes. Similar to [method move_and_slide]. As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0)[/code] or by using [method move_and_slide] instead. </description> </method> |