Preparing search index...

    An OverlapProbe whose volume is a sphere. enterRadius/exitRadius (cm) give hysteresis. Create with SpecsInteractionModule#createSphereOverlapProbe.

    Lens Scripting Version 375

    Hierarchy (View Summary)

    Index

    Properties

    enterRadius: number

    The probe's enter radius, cm.

    Lens Scripting Version 375

    exitRadius: number

    The probe's exit radius, cm.

    Lens Scripting Version 375

    Signals at most once per frame with the colliders that entered the probe's enter volume that frame, delivered as the OverlapEnterEventArgs#enteredOverlaps batch. When a frame has both enters and exits, onOverlapEnter fires before OverlapProbe#onOverlapExit. Delivered after Update, prior to LateUpdate.

    Lens Scripting Version 375

    Signals at most once per frame with the colliders that left the probe's exit volume that frame, whose collider was removed while a member, or that were still inside when the probe itself was removed, delivered as the OverlapExitEventArgs#exitedOverlaps batch. Delivered after Update, prior to LateUpdate.

    Lens Scripting Version 375

    queryMask: LayerSet

    The layers this probe matches against. A collider joins only when its Interactable's layerMask shares a layer with this set. Only layers 0-63 are supported, so this reads back without any layers above that range the probe was created with.

    Lens Scripting Version 375

    Methods

    • Stops the probe and drops it from active tracking. Any colliders still inside fire one final OverlapProbe#onOverlapExit shortly after. No further events follow. Idempotent.

      Returns void

      Lens Scripting Version 375

    • 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

    • Updates the probe's enter and exit radii (cm). exitRadius should be >= enterRadius; equal values disable hysteresis. Applied at the next overlap evaluation, after Update and before LateUpdate.

      Parameters

      • enterRadius: number
      • exitRadius: number

      Returns void

      Lens Scripting Version 375