Interface Contact

Description

Contact point between two colliding objects. See also: ColliderComponent, CollisionEnterEventArgs, CollisionExitEventArgs, CollisionStayEventArgs.

Example

// Print out information about each contact point when the collider enters a collision

// @input Physics.ColliderComponent collider

script.collider.onCollisionEnter.add(function(eventArgs) {
    var collision = eventArgs.collision;
    var contactCount = collision.contactCount;
    var contacts = collision.contacts;
    for (var i = 0; i < contactCount; ++i) {
        var contact = contacts[i];
        print("contact[" + i + "]: distance=" + contact.distance + ", impulse=" + contact.impulse);
    }
});
interface Contact {
    distance: number;
    impulse: number;
    normal: vec3;
    position: vec3;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

distance impulse normal position

Methods

getTypeName isOfType isSame

Properties

Readonly distance

distance: number

Description

Distance along the normal between the hit collider and this collider.

Readonly impulse

impulse: number

Description

Impulse (kg*cm/s) applied along the normal in response to the collision.

Readonly normal

normal: vec3

Description

Normal on the hit collider.

Readonly position

position: vec3

Description

Position on the hit 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