Lens Scripting API
    Preparing search index...

    Class OverlapEnterEventArgs

    Args for OverlapProbe#onOverlapEnter, delivered once per frame: enteredOverlaps, every membership that entered the probe's volume this frame. To track the full set currently inside, keep a collection keyed by Overlap#id, adding on enter and removing on OverlapExitEventArgs#exitedOverlaps.

    Lens Scripting Version 375

    probe.onOverlapEnter.add(function (args) {
        for (var i = 0; i < args.enteredOverlaps.length; i++) {
            print("entered " + args.enteredOverlaps[i].id);
        }
    });

    Hierarchy (View Summary)

    Index

    Properties

    enteredOverlaps

    Methods

    getTypeName getTypeName isOfType isSame

    Properties

    enteredOverlaps: SpecsInteractionModule.Overlap[]

    Every Overlap that entered the probe's volume this frame, sorted by Overlap#id. Membership is sampled once per frame, so a collider that enters and leaves between two samples is never reported. Anything reported here later appears in OverlapExitEventArgs#exitedOverlaps on the frame it leaves.

    Lens Scripting Version 375

    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

      Lens Scripting Version 375

    • 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