Interface PBRaycast

Hierarchy

  • PBRaycast

Properties

collisionMask? continuous? direction? maxDistance originOffset? queryType timestamp?

Properties

Optional collisionMask

collisionMask?: number

Collision mask, by default CL_POINTER | CL_PHYSICS

Optional continuous

continuous?: boolean

Indicates the renderer to perform the raycast on every scene tick (ADR-148), otherwise it will be performed only once, defaults to false

Optional direction

direction?: {
    $case: "localDirection";
    localDirection: PBVector3;
} | {
    $case: "globalDirection";
    globalDirection: PBVector3;
} | {
    $case: "globalTarget";
    globalTarget: PBVector3;
} | {
    $case: "targetEntity";
    targetEntity: number;
}

maxDistance

maxDistance: number

Maximum length of the ray in virtual meters (global space)

Optional originOffset

originOffset?: PBVector3

How much to offset the starting point of the ray, relative to the entity's transform. Defaults to vec3(0,0,0)

queryType

queryType: RaycastQueryType

the RaycastQueryType behavior

Optional timestamp

timestamp?: number

Correlation ID, defined by the scene and used internally by the scene

Settings

Member Visibility

Theme