Query the closest object intersecting a ray.
    public class RayCast : Spatial

A RayCast represents a line from its origin to its destination position, cast_to. It is used to query the 3D space in order to find the closest object along the path of the ray.

RayCast 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.

RayCast 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 ForceRaycastUpdate() after adjusting the raycast.

Inheritance Chain

Constructors

    public RayCast()

Properties

    public Vector3 CastTo { get; set; }

The ray’s destination point, relative to the RayCast’s position.

    public int CollisionMask { get; set; }

The ray’s collision mask. Only objects in at least one collision layer enabled in the mask will be detected.

    public bool Enabled { get; set; }

If true collisions will be reported. Default value: false.

    public bool ExcludeParent { get; set; }

If true collisions will be ignored for this RayCast’s immediate parent. Default value: true.

Methods

    public void AddException(Object node)

Adds a collision exception so the ray does not report collisions with the specified node.

    public void AddExceptionRid(RID rid)

Adds a collision exception so the ray does not report collisions with the specified RID.

    public void ClearExceptions()

Removes all collision exceptions for this ray.

    public void ForceRaycastUpdate()

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.

    public Vector3 GetCastTo()

Getter for CastTo

    public Object GetCollider()

Return the closest object the ray is pointing to. Note that this does not consider the length of the ray, so you must also use IsColliding() to check if the object returned is actually colliding with the ray.

Example:

[codeblock]

if RayCast.is_colliding():

var collider = RayCast.get_collider()

[/codeblock]

    public int GetColliderShape()

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 IsColliding() to check if the object returned is actually colliding with the ray.

Example:

[codeblock]

if RayCast.is_colliding():

var shape = RayCast.get_collider_shape()

[/codeblock]

    public int GetCollisionMask()

Getter for CollisionMask

    public bool GetCollisionMaskBit(int bit)

Returns true if the bit index passed is turned on. Note that bit indexes range from 0-19.

    public Vector3 GetCollisionNormal()

Returns the normal of the intersecting object’s shape at the collision point.

    public Vector3 GetCollisionPoint()

Returns the collision point at which the ray intersects the closest object. Note: this point is in the global coordinate system.

    public bool GetExcludeParentBody()

Getter for ExcludeParent

    public bool IsColliding()

Return whether the closest object the ray is pointing to is colliding with the vector (considering the vector length).

    public bool IsEnabled()

Getter for Enabled

    public void RemoveException(Object node)

Removes a collision exception so the ray does report collisions with the specified node.

    public void RemoveExceptionRid(RID rid)

Removes a collision exception so the ray does report collisions with the specified RID.

    public void SetCastTo(Vector3 localPoint)

Setter for CastTo

    public void SetCollisionMask(int mask)

Setter for CollisionMask

    public void SetCollisionMaskBit(int bit, bool value)

Sets the bit index passed to the value passed. Note that bit indexes range from 0-19.

    public void SetEnabled(bool enabled)

Setter for Enabled

    public void SetExcludeParentBody(bool mask)

Setter for ExcludeParent

Tags: