Interface Collision

A state generated for ColliderComponent collision events.

interface Collision {
    collider: ColliderComponent;
    contactCount: number;
    contacts: Contact[];
    id: number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

collider contactCount contacts id

Methods

getTypeName isOfType isSame

Properties

Readonlycollider

collider: ColliderComponent

Primitive shapes that physics objects interact with, such as spheres, boxes, and meshes, or compound shapes formed from multiple shapes. Used with Physics, Hair Simulation and Cloth Simulation.

ReadonlycontactCount

contactCount: number

The number of contact points in the collision.

Readonlycontacts

contacts: Contact[]

Array of contacts in the collision.

Readonlyid

id: number

ID of the collision, unique for this collider.

Methods

getTypeName

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods