5183c473f7
For both 2D and 3D, three methods are added: - `get_floor_angle` on `KinematicBody` to get the floor angle. - `get_angle` on `KinematicCollision` to get the collision angle. - `get_last_slide_collision` to quickly get the latest collision of `move_and_slide`.
149 lines
11 KiB
XML
149 lines
11 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="KinematicBody2D" inherits="PhysicsBody2D" version="3.4">
|
|
<brief_description>
|
|
Kinematic body 2D node.
|
|
</brief_description>
|
|
<description>
|
|
Kinematic bodies are special types of bodies that are meant to be user-controlled. They are not affected by physics at all; to other types of bodies, such as a character or a rigid body, these are the same as a static body. However, they have two main uses:
|
|
[b]Simulated motion:[/b] When these bodies are moved manually, either from code or from an [AnimationPlayer] (with [member AnimationPlayer.playback_process_mode] set to "physics"), the physics will automatically compute an estimate of their linear and angular velocity. This makes them very useful for moving platforms or other AnimationPlayer-controlled objects (like a door, a bridge that opens, etc).
|
|
[b]Kinematic characters:[/b] KinematicBody2D also has an API for moving objects (the [method move_and_collide] and [method move_and_slide] methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but don't require advanced physics.
|
|
</description>
|
|
<tutorials>
|
|
<link title="Kinematic character (2D)">https://docs.godotengine.org/en/3.4/tutorials/physics/kinematic_character_2d.html</link>
|
|
<link title="Using KinematicBody2D">https://docs.godotengine.org/en/3.4/tutorials/physics/using_kinematic_body_2d.html</link>
|
|
<link title="2D Kinematic Character Demo">https://godotengine.org/asset-library/asset/113</link>
|
|
<link title="2D Platformer Demo">https://godotengine.org/asset-library/asset/120</link>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_floor_angle" qualifiers="const">
|
|
<return type="float" />
|
|
<argument index="0" name="up_direction" type="Vector2" default="Vector2( 0, -1 )" />
|
|
<description>
|
|
Returns the floor's collision angle at the last collision point according to [code]up_direction[/code], which is [code]Vector2.UP[/code] by default. This value is always positive and only valid after calling [method move_and_slide] and when [method is_on_floor] returns [code]true[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_floor_normal" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the surface normal of the floor at the last collision point. Only valid after calling [method move_and_slide] or [method move_and_slide_with_snap] and when [method is_on_floor] returns [code]true[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_floor_velocity" qualifiers="const">
|
|
<return type="Vector2" />
|
|
<description>
|
|
Returns the linear velocity of the floor at the last collision point. Only valid after calling [method move_and_slide] or [method move_and_slide_with_snap] and when [method is_on_floor] returns [code]true[/code].
|
|
</description>
|
|
</method>
|
|
<method name="get_last_slide_collision">
|
|
<return type="KinematicCollision2D" />
|
|
<description>
|
|
Returns a [KinematicCollision2D], which contains information about the latest collision that occurred during the last call to [method move_and_slide].
|
|
</description>
|
|
</method>
|
|
<method name="get_slide_collision">
|
|
<return type="KinematicCollision2D" />
|
|
<argument index="0" name="slide_idx" type="int" />
|
|
<description>
|
|
Returns a [KinematicCollision2D], which contains information about a collision that occurred during the last call to [method move_and_slide] or [method move_and_slide_with_snap]. Since the body can collide several times in a single call to [method move_and_slide], you must specify the index of the collision in the range 0 to ([method get_slide_count] - 1).
|
|
[b]Example usage:[/b]
|
|
[codeblock]
|
|
for i in get_slide_count():
|
|
var collision = get_slide_collision(i)
|
|
print("Collided with: ", collision.collider.name)
|
|
[/codeblock]
|
|
</description>
|
|
</method>
|
|
<method name="get_slide_count" qualifiers="const">
|
|
<return type="int" />
|
|
<description>
|
|
Returns the number of times the body collided and changed direction during the last call to [method move_and_slide] or [method move_and_slide_with_snap].
|
|
</description>
|
|
</method>
|
|
<method name="is_on_ceiling" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the body collided with the ceiling on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="is_on_floor" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the body collided with the floor on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="is_on_wall" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if the body collided with a wall on the last call of [method move_and_slide] or [method move_and_slide_with_snap]. Otherwise, returns [code]false[/code].
|
|
</description>
|
|
</method>
|
|
<method name="move_and_collide">
|
|
<return type="KinematicCollision2D" />
|
|
<argument index="0" name="rel_vec" type="Vector2" />
|
|
<argument index="1" name="infinite_inertia" type="bool" default="true" />
|
|
<argument index="2" name="exclude_raycast_shapes" type="bool" default="true" />
|
|
<argument index="3" name="test_only" type="bool" default="false" />
|
|
<description>
|
|
Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision2D], which contains information about the collision.
|
|
If [code]test_only[/code] is [code]true[/code], the body does not move but the would-be collision information is given.
|
|
</description>
|
|
</method>
|
|
<method name="move_and_slide">
|
|
<return type="Vector2" />
|
|
<argument index="0" name="linear_velocity" type="Vector2" />
|
|
<argument index="1" name="up_direction" type="Vector2" default="Vector2( 0, 0 )" />
|
|
<argument index="2" name="stop_on_slope" type="bool" default="false" />
|
|
<argument index="3" name="max_slides" type="int" default="4" />
|
|
<argument index="4" name="floor_max_angle" type="float" default="0.785398" />
|
|
<argument index="5" name="infinite_inertia" type="bool" default="true" />
|
|
<description>
|
|
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 [KinematicBody2D] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes.
|
|
This method should be used in [method Node._physics_process] (or in a method called by [method Node._physics_process]), as it uses the physics step's [code]delta[/code] value automatically in calculations. Otherwise, the simulation will run at an incorrect speed.
|
|
[code]linear_velocity[/code] is the velocity vector in pixels per second. Unlike in [method move_and_collide], you should [i]not[/i] multiply it by [code]delta[/code] — the physics engine handles applying the velocity.
|
|
[code]up_direction[/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 [code]stop_on_slope[/code] is [code]true[/code], body will not slide on slopes when you include gravity in [code]linear_velocity[/code] and the body is standing still.
|
|
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.
|
|
If [code]infinite_inertia[/code] is [code]true[/code], body will be able to push [RigidBody2D] nodes, but it won't also detect any collisions with them. If [code]false[/code], it will interact with [RigidBody2D] nodes like with [StaticBody2D].
|
|
Returns the [code]linear_velocity[/code] vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use [method get_slide_collision].
|
|
When the body touches a moving platform, the platform's velocity is automatically added to the body motion. If a collision occurs due to the platform's motion, it will always be first in the slide collisions.
|
|
</description>
|
|
</method>
|
|
<method name="move_and_slide_with_snap">
|
|
<return type="Vector2" />
|
|
<argument index="0" name="linear_velocity" type="Vector2" />
|
|
<argument index="1" name="snap" type="Vector2" />
|
|
<argument index="2" name="up_direction" type="Vector2" default="Vector2( 0, 0 )" />
|
|
<argument index="3" name="stop_on_slope" type="bool" default="false" />
|
|
<argument index="4" name="max_slides" type="int" default="4" />
|
|
<argument index="5" name="floor_max_angle" type="float" default="0.785398" />
|
|
<argument index="6" name="infinite_inertia" type="bool" default="true" />
|
|
<description>
|
|
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>
|
|
<method name="test_move">
|
|
<return type="bool" />
|
|
<argument index="0" name="from" type="Transform2D" />
|
|
<argument index="1" name="rel_vec" type="Vector2" />
|
|
<argument index="2" name="infinite_inertia" type="bool" default="true" />
|
|
<description>
|
|
Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given [Transform2D], then tries to move the body along the vector [code]rel_vec[/code]. Returns [code]true[/code] if a collision would occur.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin" default="0.08">
|
|
Extra margin used for collision recovery in motion functions (see [method move_and_collide], [method move_and_slide], [method move_and_slide_with_snap]).
|
|
If the body is at least this close to another body, it will consider them to be colliding and will be pushed away before performing the actual motion.
|
|
A higher value means it's more flexible for detecting collision, which helps with consistently detecting walls and floors.
|
|
A lower value forces the collision algorithm to use more exact detection, so it can be used in cases that specifically require precision, e.g at very low scale to avoid visible jittering, or for stability with a stack of kinematic bodies.
|
|
</member>
|
|
<member name="motion/sync_to_physics" type="bool" setter="set_sync_to_physics" getter="is_sync_to_physics_enabled" default="false">
|
|
If [code]true[/code], the body's movement will be synchronized to the physics frame. This is useful when animating movement via [AnimationPlayer], for example on moving platforms. Do [b]not[/b] use together with [method move_and_slide] or [method move_and_collide] functions.
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|