Kinematic body 3D node.
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:
Simulated motion: When these bodies are moved manually, either from code or from an AnimationPlayer (with 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).
Kinematic characters: KinematicBody also has an API for moving objects (the move_and_collide and move_and_slide methods) while performing collision tests. This makes them really useful to implement characters that collide against a world, but that don't require advanced physics.
|bool||get_axis_lock ( BodyAxis axis ) const|
|Vector3||get_floor_normal ( ) const|
|Vector3||get_floor_velocity ( ) const|
|KinematicCollision||get_slide_collision ( int slide_idx )|
|int||get_slide_count ( ) const|
|bool||is_on_ceiling ( ) const|
|bool||is_on_floor ( ) const|
|bool||is_on_wall ( ) const|
|KinematicCollision||move_and_collide ( Vector3 rel_vec, bool infinite_inertia=true, bool exclude_raycast_shapes=true, bool test_only=false )|
|Vector3||move_and_slide ( Vector3 linear_velocity, Vector3 up_direction=Vector3( 0, 0, 0 ), bool stop_on_slope=false, int max_slides=4, float floor_max_angle=0.785398, bool infinite_inertia=true )|
|Vector3||move_and_slide_with_snap ( Vector3 linear_velocity, Vector3 snap, Vector3 up_direction=Vector3( 0, 0, 0 ), bool stop_on_slope=false, int max_slides=4, float floor_max_angle=0.785398, bool infinite_inertia=true )|
|void||set_axis_lock ( BodyAxis axis, bool lock )|
|bool||test_move ( Transform from, Vector3 rel_vec, bool infinite_inertia=true )|
- float collision/safe_margin
If the body is at least this close to another body, this body will consider them to be colliding.
- bool move_lock_x
Lock the body's X axis movement.
- bool move_lock_y
Lock the body's Y axis movement.
- bool move_lock_z
Lock the body's Z axis movement.
- Vector3 get_floor_normal ( ) const
- Vector3 get_floor_velocity ( ) const
Returns a KinematicCollision, which contains information about a collision that occurred during the last move_and_slide call. Since the body can collide several times in a single call to move_and_slide, you must specify the index of the collision in the range 0 to (get_slide_count - 1).
- int get_slide_count ( ) const
Returns the number of times the body collided and changed direction during the last call to move_and_slide.
- bool is_on_ceiling ( ) const
true if the body is on the ceiling. Only updates when calling move_and_slide.
- bool is_on_floor ( ) const
true if the body is on the floor. Only updates when calling move_and_slide.
- bool is_on_wall ( ) const
true if the body is on a wall. Only updates when calling move_and_slide.
- KinematicCollision move_and_collide ( Vector3 rel_vec, bool infinite_inertia=true, bool exclude_raycast_shapes=true, bool test_only=false )
Moves the body along the vector
rel_vec. The body will stop if it collides. Returns a KinematicCollision, which contains information about the collision.
true, the body does not move but the would-be collision information is given.
- Vector3 move_and_slide ( Vector3 linear_velocity, Vector3 up_direction=Vector3( 0, 0, 0 ), bool stop_on_slope=false, int max_slides=4, float floor_max_angle=0.785398, bool infinite_inertia=true )
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
KinematicBody or RigidBody, 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.
This method should be used in Node._physics_process (or in a method called by Node._physics_process), as it uses the physics step's
delta value automatically in calculations. Otherwise, the simulation will run at an incorrect speed.
linear_velocity is the velocity vector (typically meters per second). Unlike in move_and_collide, you should not multiply it by
delta — the physics engine handles applying the velocity.
up_direction 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
Vector3(0, 0, 0), everything is considered a wall.
true, body will not slide on slopes when you include gravity in
linear_velocity and the body is standing still.
If the body collides, it will change direction a maximum of
max_slides times before it stops.
floor_max_angle 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.
linear_velocity vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use get_slide_collision.
- Vector3 move_and_slide_with_snap ( Vector3 linear_velocity, Vector3 snap, Vector3 up_direction=Vector3( 0, 0, 0 ), bool stop_on_slope=false, int max_slides=4, float floor_max_angle=0.785398, bool infinite_inertia=true )
Moves the body while keeping it attached to slopes. Similar to move_and_slide.
As long as the
snap 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
(0, 0, 0) or by using move_and_slide instead.
Checks for collisions without moving the body. Virtually sets the node's position, scale and rotation to that of the given Transform, then tries to move the body along the vector
true if a collision would occur.