KinematicBody2D

Inherits: PhysicsBody2D < CollisionObject2D < Node2D < CanvasItem < Node < Object

Nodo 2D del cuerpo cinético.

Descripción

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: KinematicBody2D 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 don't require advanced physics.

Tutoriales

Propiedades

float

collision/safe_margin

0.08

bool

motion/sync_to_physics

false

Métodos

float

get_floor_angle ( Vector2 up_direction=Vector2( 0, -1 ) ) const

Vector2

get_floor_normal ( ) const

Vector2

get_floor_velocity ( ) const

KinematicCollision2D

get_last_slide_collision ( )

KinematicCollision2D

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

KinematicCollision2D

move_and_collide ( Vector2 rel_vec, bool infinite_inertia=true, bool exclude_raycast_shapes=true, bool test_only=false )

Vector2

move_and_slide ( Vector2 linear_velocity, Vector2 up_direction=Vector2( 0, 0 ), bool stop_on_slope=false, int max_slides=4, float floor_max_angle=0.785398, bool infinite_inertia=true )

Vector2

move_and_slide_with_snap ( Vector2 linear_velocity, Vector2 snap, Vector2 up_direction=Vector2( 0, 0 ), bool stop_on_slope=false, int max_slides=4, float floor_max_angle=0.785398, bool infinite_inertia=true )

bool

test_move ( Transform2D from, Vector2 rel_vec, bool infinite_inertia=true )

Descripciones de Propiedades

  • float collision/safe_margin

Default

0.08

Setter

set_safe_margin(value)

Getter

get_safe_margin()

Extra margin used for collision recovery in motion functions (see move_and_collide, move_and_slide, 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.


  • bool motion/sync_to_physics

Default

false

Setter

set_sync_to_physics(value)

Getter

is_sync_to_physics_enabled()

Si true, el movimiento del cuerpo se sincronizará con el marco de la física. Esto es útil cuando se anima el movimiento a través de AnimationPlayer, por ejemplo en plataformas móviles. No uses not junto con las funciones move_and_slide o move_and_collide.

Descripciones de Métodos

  • float get_floor_angle ( Vector2 up_direction=Vector2( 0, -1 ) ) const

Returns the floor's collision angle at the last collision point according to up_direction, which is Vector2.UP by default. This value is always positive and only valid after calling move_and_slide and when is_on_floor returns true.


  • Vector2 get_floor_normal ( ) const

Devuelve la normal de la superficie del suelo en el último punto de colisión. Sólo válido después de llamar a move_and_slide o move_and_slide_with_snap y cuando is_on_floor devuelve true.


  • Vector2 get_floor_velocity ( ) const

Devuelve la velocidad lineal del suelo en el último punto de colisión. Sólo es válido después de llamar a move_and_slide o move_and_slide_with_snap y cuando is_on_floor devuelve true.


Returns a KinematicCollision2D, which contains information about the latest collision that occurred during the last call to move_and_slide.


Returns a KinematicCollision2D, which contains information about a collision that occurred during the last call to move_and_slide or move_and_slide_with_snap. 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).

Example usage:

for i in get_slide_count():
    var collision = get_slide_collision(i)
    print("Collided with: ", collision.collider.name)

  • int get_slide_count ( ) const

Returns the number of times the body collided and changed direction during the last call to move_and_slide or move_and_slide_with_snap.


  • bool is_on_ceiling ( ) const

Returns true if the body collided with the ceiling on the last call of move_and_slide or move_and_slide_with_snap. Otherwise, returns false.


  • bool is_on_floor ( ) const

Returns true if the body collided with the floor on the last call of move_and_slide or move_and_slide_with_snap. Otherwise, returns false.


  • bool is_on_wall ( ) const

Returns true if the body collided with a wall on the last call of move_and_slide or move_and_slide_with_snap. Otherwise, returns false.


Moves the body along the vector rel_vec. The body will stop if it collides. Returns a KinematicCollision2D, which contains information about the collision when stopped, or when touching another body along the motion.

If test_only is true, the body does not move but the would-be collision information is given.


  • Vector2 move_and_slide ( Vector2 linear_velocity, Vector2 up_direction=Vector2( 0, 0 ), bool stop_on_slope=false, int max_slides=4, float floor_max_angle=0.785398, bool infinite_inertia=true )

Mueve el cuerpo a lo largo de un vector. Si el cuerpo choca con otro, se deslizará a lo largo del otro cuerpo en lugar de detenerse inmediatamente. Si el otro cuerpo es un KinematicBody2D o un RigidBody2D, también se verá afectado por el movimiento del otro cuerpo. Puedes usar esto para hacer plataformas móviles o giratorias, o para hacer que los nodos empujen a otros nodos.

Este método debe ser usado en Node._physics_process (o en un método llamado por Node._physics_process), ya que usa el valor del paso de física delta automáticamente en los cálculos. De lo contrario, la simulación se ejecutará a una velocidad incorrecta.

linear_velocity es el vector de velocidad en píxeles por segundo. A diferencia del move_and_collide, debes no multiplicarlo por delta - el motor de física se encarga de aplicar la velocidad.

up_direction es la dirección hacia arriba, usada para determinar qué es una pared y qué es un piso o un techo. Si se establece el valor por defecto de Vector2(0, 0), todo se considera una pared. Esto es útil para los juegos de arriba hacia abajo.

Si stop_on_slope es true, el cuerpo no se deslizará por las pendientes cuando incluyas la gravedad en linear_velocity y el cuerpo se quede quieto.

Si el cuerpo colisiona, cambiará de dirección un máximo de max_slides veces antes de detenerse.

floor_max_angle es el ángulo máximo (en radianes) en el que una pendiente se considera todavía un suelo (o un techo), en lugar de una pared. El valor por defecto es igual a 45 grados.

Si infinite_inertia es true, el cuerpo podrá empujar los nodos de RigidBody2D, pero no detectará ninguna colisión con ellos. Si false, interactuará con los nodos de RigidBody2D como con StaticBody2D.

Devuelve el vector linear_velocity, rotado y/o escalado si se produjo una colisión de deslizamiento. Para obtener información detallada sobre las colisiones ocurridas, usa get_slide_collision.


Mueve el cuerpo mientras lo mantiene unido a las laderas. Similar al move_and_slide.

Mientras el vector snap esté en contacto con el suelo, el cuerpo permanecerá unido a la superficie. Esto significa que debes desactivar el snap para poder saltar, por ejemplo. Puedes hacerlo poniendo snap en (0, 0) o usando move_and_slide en su lugar.


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 rel_vec. Returns true if a collision would stop the body from moving along the whole path.

Use move_and_collide instead for detecting collision with touching bodies.