Lens Scripting API
    Preparing search index...

    Class OverlapEnterEventArgs

    Args used for ColliderComponent.onOverlapEnter, which is triggered when the collider begins overlapping another object. Typically used for volume triggers

    // 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)

    Index

    Properties

    currentOverlapCount currentOverlaps overlap

    Methods

    getTypeName getTypeName isOfType isSame

    Properties

    currentOverlapCount: number

    Number of objects currently overlapping.

    currentOverlaps: Overlap[]

    Array of all current overlaps.

    overlap: Overlap

    Structure containing information about the current overlap.

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

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

      Parameters

      • type: string

      Returns 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