Class Overlap

Exposes state generated for ColliderComponent overlap events.

See

Example

// When the collider begins to overlap another collider, print information about the overlap

// @input Physics.ColliderComponent collider

script.collider.onOverlapEnter.add(function (e) {
    var overlap = e.overlap;
    print("OverlapEnter(" + overlap.id + "): Overlap with: " + overlap.collider.getSceneObject().name);
});

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

collider id

Methods

getTypeName isOfType isSame

Constructors

Protectedconstructor

Properties

Readonlycollider

collider: ColliderComponent

The collider which is overlapping.

Readonlyid

id: number

ID of the overlap, unique for this overlap.

Methods

getTypeName

isOfType

  • isOfType(type: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): 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

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR