diff options
| author | fabriceci <fabricecipolla@gmail.com> | 2023-02-21 22:34:44 +0100 |
|---|---|---|
| committer | fabriceci <fabricecipolla@gmail.com> | 2023-02-22 14:08:32 +0100 |
| commit | 1381e6da4f695323853b24cf8d3632604b629133 (patch) | |
| tree | d027cbbb22e8e7dff86d21fa1107e45cbb78b992 /doc/classes/CharacterBody3D.xml | |
| parent | 7e79aead99a53ee7cdf383add9a6a2aea4f15beb (diff) | |
| download | redot-engine-1381e6da4f695323853b24cf8d3632604b629133.tar.gz | |
Exposes the apply_floor_snap function to allow a snap to be made regardless of velocity.
Diffstat (limited to 'doc/classes/CharacterBody3D.xml')
| -rw-r--r-- | doc/classes/CharacterBody3D.xml | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/classes/CharacterBody3D.xml b/doc/classes/CharacterBody3D.xml index 2ff207acb7..8b511e5a72 100644 --- a/doc/classes/CharacterBody3D.xml +++ b/doc/classes/CharacterBody3D.xml @@ -17,6 +17,12 @@ <link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link> </tutorials> <methods> + <method name="apply_floor_snap"> + <return type="void" /> + <description> + Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when [method is_on_floor] returns [code]true[/code]. + </description> + </method> <method name="get_floor_angle" qualifiers="const"> <return type="float" /> <param index="0" name="up_direction" type="Vector3" default="Vector3(0, 1, 0)" /> @@ -144,7 +150,7 @@ </member> <member name="floor_snap_length" type="float" setter="set_floor_snap_length" getter="get_floor_snap_length" default="0.1"> Sets a snapping distance. When set to a value different from [code]0.0[/code], the body is kept attached to slopes when calling [method move_and_slide]. The snapping vector is determined by the given distance along the opposite direction of the [member up_direction]. - As long as the snapping vector is in contact with the ground and the body moves against [member up_direction], the body will remain attached to the surface. Snapping is not applied if the body moves along [member up_direction], so it will be able to detach from the ground when jumping. + As long as the snapping vector is in contact with the ground and the body moves against [member up_direction], the body will remain attached to the surface. Snapping is not applied if the body moves along [member up_direction], meaning it contains vertical rising velocity, so it will be able to detach from the ground when jumping or when the body is pushed up by something. If you want to apply a snap without taking into account the velocity, use [method apply_floor_snap]. </member> <member name="floor_stop_on_slope" type="bool" setter="set_floor_stop_on_slope_enabled" getter="is_floor_stop_on_slope_enabled" default="true"> If [code]true[/code], the body will not slide on slopes when calling [method move_and_slide] when the body is standing still. |