Query the closest object intersecting a ray.
|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 )|
true, collisions will be reported. Default value:
true, the parent node will be excluded from collision detection. Default value:
A RayCast represents a line from its origin to its destination position,
cast_to. It is used to query the 2D space in order to find the closest object along the path of the ray.
RayCast2D can ignore some objects by adding them to the exception list via
add_exception, by setting proper filtering with collision layers, or by filtering object types with type masks.
Only enabled raycasts will be able to query the space and report collisions.
RayCast2D calculates intersection every physics frame (see Node), and the result is cached so it can be used later until the next frame. If multiple queries are required between physics frames (or during the same frame) use force_raycast_update after adjusting the raycast.
Adds a collision exception so the ray does not report collisions with the specified node.
Adds a collision exception so the ray does not report collisions with the specified RID.
Removes all collision exceptions for this ray.
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 == true is not required for this to work.
Returns the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use is_colliding to check if the object returned is actually colliding with the ray.
if RayCast2D.is_colliding(): var collider = RayCast2D.get_collider()
Returns the collision shape of the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use is_colliding to check if the object returned is actually colliding with the ray.
if RayCast2D.is_colliding(): var shape = RayCast2D.get_collider_shape()
Return an individual bit on the collision mask.
Returns the normal of the intersecting object’s shape at the collision point.
Returns the collision point at which the ray intersects the closest object. Note: this point is in the global coordinate system.
Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).
Removes a collision exception so the ray does report collisions with the specified node.
Removes a collision exception so the ray does report collisions with the specified RID.
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
© 2014–2018 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.