RayCast2D

Inherits: Node2D < CanvasItem < Node < Object

Busca el objeto más cercano que intersecta un rayo.

Descripción

Un RayCast representa una línea desde su origen hasta su posición de destino, cast_to. Se utiliza para consultar el espacio 2D con el fin de encontrar el objeto más cercano a lo largo de la trayectoria del rayo.

RayCast2D puede ignorar algunos objetos añadiéndolos a la lista de excepciones mediante add_exception, estableciendo un filtrado adecuado con las capas de colisión, o filtrando los tipos de objetos con máscaras de tipo.

RayCast2D puede ser configurado para reportar colisiones con Area2Ds (collide_with_areas) y/o PhysicsBody2Ds (collide_with_bodies).

Sólo las emisiones de rayos habilitadas podrán consultar el espacio e informar de las colisiones.

RayCast2D calcula la intersección de cada cuadro de física (ver Node), y el resultado se almacena en caché para poder ser utilizado más tarde hasta el siguiente cuadro. Si se requieren múltiples consultas entre marcos físicos (o durante el mismo marco) utilice force_raycast_update después de ajustar el raycast.

Tutoriales

Propiedades

Vector2

cast_to

Vector2( 0, 50 )

bool

collide_with_areas

false

bool

collide_with_bodies

true

int

collision_mask

1

bool

enabled

false

bool

exclude_parent

true

Métodos

void

add_exception ( Object node )

void

add_exception_rid ( RID rid )

void

clear_exceptions ( )

void

force_raycast_update ( )

Object

get_collider ( ) const

int

get_collider_shape ( ) const

bool

get_collision_mask_bit ( int bit ) const

Vector2

get_collision_normal ( ) const

Vector2

get_collision_point ( ) const

bool

is_colliding ( ) const

void

remove_exception ( Object node )

void

remove_exception_rid ( RID rid )

void

set_collision_mask_bit ( int bit, bool value )

Descripciones de Propiedades

Default

Vector2( 0, 50 )

Setter

set_cast_to(value)

Getter

get_cast_to()

El punto de destino del rayo, relativo a la position del RayCast.

  • bool collide_with_areas

Default

false

Setter

set_collide_with_areas(value)

Getter

is_collide_with_areas_enabled()

Si true, se informará de la colisión con Area2Ds.

  • bool collide_with_bodies

Default

true

Setter

set_collide_with_bodies(value)

Getter

is_collide_with_bodies_enabled()

Si true, se informará de la colisión con PhysicsBody2D.

  • int collision_mask

Default

1

Setter

set_collision_mask(value)

Getter

get_collision_mask()

The ray's collision mask. Only objects in at least one collision layer enabled in the mask will be detected. See Collision layers and masks in the documentation for more information.

Default

false

Setter

set_enabled(value)

Getter

is_enabled()

Si true, se informará de las colisiones.

  • bool exclude_parent

Default

true

Setter

set_exclude_parent_body(value)

Getter

get_exclude_parent_body()

Si true, el nodo padre será excluido de la detección de colisiones.

Descripciones de Métodos

  • void add_exception ( Object node )

Añade una excepción de colisión para que el rayo no informe de las colisiones con el nodo 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 ( )

Updates the collision information for the ray. Use this method to update the collision information immediately instead of waiting for the next _physics_process call, for example if the ray or its parent has changed state.

Note: enabled is not required for this to work.

  • Object get_collider ( ) const

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

  • int get_collider_shape ( ) const

Devuelve el ID de la forma del primer objeto que el rayo intersecta, o 0 si no hay ningún objeto que intersecte el rayo (es decir, is_colliding devuelve false).

  • bool get_collision_mask_bit ( int bit ) const

Devuelve un bit individual de la máscara de colisión.

  • Vector2 get_collision_normal ( ) const

Devuelve la normalidad de la forma del objeto que se intersecta en el punto de colisión.

  • Vector2 get_collision_point ( ) const

Devuelve el punto de colisión en el que el rayo intersecta el objeto más cercano.

Nota: Este punto está en el sistema de coordenadas global.

  • bool is_colliding ( ) const

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

  • void remove_exception ( Object node )

Elimina una excepción de colisión para que el rayo informe de las colisiones con el nodo especificado.

  • void remove_exception_rid ( RID rid )

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

  • void set_collision_mask_bit ( int bit, bool value )

Establece o borra bits individuales en la máscara de colisión. Esto hace que la selección de las áreas escaneadas sea más fácil.