Interface Collision

Description

A state generated for ColliderComponent collision events.

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

Hierarchy (view full)

Properties

collider contactCount contacts id

Methods

getTypeName isOfType isSame

Properties

Readonly collider

collider: ColliderComponent

Description

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.

Readonly contactCount

contactCount: number

Description

The number of contact points in the collision.

Readonly contacts

contacts: Contact[]

Description

Array of contacts in the collision.

Readonly id

id: number

Description

ID of the collision, unique for this collider.

Methods

getTypeName

  • getTypeName(): string

  • Returns string

    Description

    Returns the name of this object's type.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

  • Parameters

    Returns boolean

    Description

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc