RayCast2D

Hereda: Node2D < CanvasItem < Node < Object

Un rayo en el espacio 2D, utilizado para encontrar el primer objeto de colisión que interseca.

Descripción

A raycast represents a ray from its origin to its target_position that finds the closest object along its path, if it intersects any.

RayCast2D can ignore some objects by adding them to an exception list, by making its detection reporting ignore Area2Ds (collide_with_areas) or PhysicsBody2Ds (collide_with_bodies), or by configuring physics layers.

RayCast2D calculates intersection every physics frame, and it holds the result until the next physics frame. For an immediate raycast, or if you want to configure a RayCast2D multiple times within the same physics frame, use force_raycast_update().

To sweep over a region of 2D space, you can approximate the region with multiple RayCast2Ds or use ShapeCast2D.

Tutoriales

• Ray casting

Propiedades

bool	collide_with_areas	false
bool	collide_with_bodies	true
int	collision_mask	1
bool	enabled	true
bool	exclude_parent	true
bool	hit_from_inside	false
Vector2	target_position	Vector2(0, 50)

Métodos

void	add_exception(node: CollisionObject2D)
void	add_exception_rid(rid: RID)
void	clear_exceptions()
void	force_raycast_update()
Object	get_collider() const
RID	get_collider_rid() const
int	get_collider_shape() const
bool	get_collision_mask_value(layer_number: int) const
Vector2	get_collision_normal() const
Vector2	get_collision_point() const
bool	is_colliding() const
void	remove_exception(node: CollisionObject2D)
void	remove_exception_rid(rid: RID)
void	set_collision_mask_value(layer_number: int, value: bool)

---

Descripciones de Propiedades

bool collide_with_areas = false 🔗

• void set_collide_with_areas(value: bool)

• bool is_collide_with_areas_enabled()

Si es true, se informará de las colisiones con Area2Ds.

---

bool collide_with_bodies = true 🔗

• void set_collide_with_bodies(value: bool)

• bool is_collide_with_bodies_enabled()

Si es true, se informará de las colisiones con PhysicsBody2Ds.

---

int collision_mask = 1 🔗

• void set_collision_mask(value: int)

• int get_collision_mask()

La máscara de colisión del rayo. Solo se detectarán los objetos en al menos una capa de colisión habilitada en la máscara. Véase Capas y máscaras de colisión en la documentación para obtener más información.

---

bool enabled = true 🔗

• void set_enabled(value: bool)

• bool is_enabled()

Si es true, se informará de las colisiones.

---

bool exclude_parent = true 🔗

• void set_exclude_parent_body(value: bool)

• bool get_exclude_parent_body()

Si es true, este raycast no informará de las colisiones con su nodo padre. Esta propiedad solo tiene efecto si el nodo padre es un CollisionObject2D. Véase también Node.get_parent() y add_exception().

---

bool hit_from_inside = false 🔗

• void set_hit_from_inside(value: bool)

• bool is_hit_from_inside_enabled()

Si es true, el rayo detectará un impacto cuando comience dentro de las formas. En este caso, la normal de colisión será Vector2(0, 0). No afecta a las formas de polígono cóncavas.

---

Vector2 target_position = Vector2(0, 50) 🔗

• void set_target_position(value: Vector2)

• Vector2 get_target_position()

El punto de destino del rayo, relativo a la Node2D.position de este raycast.

---

Descripciones de Métodos

void add_exception(node: CollisionObject2D) 🔗

Añade una excepción de colisión para que el rayo no reporte colisiones con el node especificado.

---

void add_exception_rid(rid: RID) 🔗

Añade una excepción de colisión para que el rayo no reporte colisiones con el RID especificado.

---

void clear_exceptions() 🔗

Elimina todas las excepciones de colisión para este rayo.

---

void force_raycast_update() 🔗

Actualiza la información de colisión del rayo inmediatamente, sin esperar a la siguiente llamada a _physics_process. Usa este método, por ejemplo, cuando el rayo o su padre han cambiado de estado.

Nota: No es necesario que enabled sea true para que esto funcione.

---

Object get_collider() const 🔗

Devuelve el primer objeto que el rayo interseca, o null si no hay ningún objeto que interseca el rayo (es decir, is_colliding() devuelve false).

Nota: No se garantiza que este objeto sea un CollisionObject2D. Por ejemplo, si el rayo interseca un TileMapLayer, el método devolverá una instancia de TileMapLayer.

---

RID get_collider_rid() const 🔗

Devuelve el RID del primer objeto que el rayo interseca, o un RID vacío si ningún objeto interseca el rayo (es decir, is_colliding() devuelve false).

---

int get_collider_shape() const 🔗

Returns the shape ID of the first object that the ray intersects, or 0 if no object is intersecting the ray (i.e. is_colliding() returns false).

To get the intersected shape node, for a CollisionObject2D target, use:

GDScriptC#

var target = get_collider() # A CollisionObject2D.
var shape_id = get_collider_shape() # The shape index in the collider.
var owner_id = target.shape_find_owner(shape_id) # The owner ID in the collider.
var shape = target.shape_owner_get_owner(owner_id)

---

bool get_collision_mask_value(layer_number: int) const 🔗

Devuelve si la capa especificada de collision_mask está habilitada o no, dado un layer_number entre 1 y 32.

---

Vector2 get_collision_normal() const 🔗

Devuelve la normal de la forma del objeto que interseca en el punto de colisión, o Vector2(0, 0) si el rayo comienza dentro de la forma y hit_from_inside es true.

Nota: Comprueba que is_colliding() devuelve true antes de llamar a este método para asegurarte de que la normal devuelta es válida y está actualizada.

---

Vector2 get_collision_point() const 🔗

Devuelve el punto de colisión en el que el rayo interseca el objeto más cercano, en el sistema de coordenadas global. Si hit_from_inside es true y el rayo comienza dentro de una forma de colisión, esta función devolverá el punto de origen del rayo.

Nota: Comprueba que is_colliding() devuelve true antes de llamar a este método para asegurarte de que el punto devuelto es válido y está actualizado.

---

bool is_colliding() const 🔗

Devuelve si algún objeto se cruza con el vector del rayo (considerando la longitud del vector).

---

void remove_exception(node: CollisionObject2D) 🔗

Elimina una excepción de colisión para que el rayo pueda informar de colisiones con el node especificado.

---

void remove_exception_rid(rid: RID) 🔗

Elimina una excepción de colisión para que el rayo pueda informar de colisiones con el RID especificado.

---

void set_collision_mask_value(layer_number: int, value: bool) 🔗

Basado en value, habilita o deshabilita la capa especificada en collision_mask, dado un layer_number entre 1 y 32.