Atlas Engine
API Referencebezel

RaycastResult

Ray query hits and nearest-hit information; hit is null when no closest hit exists.

Module: bezel

Ray query hits and nearest-hit information; hit is null when no closest hit exists.

Declaration

export type RaycastResult = {
        /**
         * The collection of hits.
         */
        hits: RaycastHit[];
        /**
         * The hit, or `null` when unavailable.
         */
        hit: RaycastHit | null;
        /**
         * The closest distance.
         */
        closestDistance: number;
    };

Properties

hits

The collection of hits.

hits: RaycastHit[];

hit

The hit, or null when unavailable.

hit: RaycastHit | null;

closestDistance

The closest distance.

closestDistance: number;

On this page