Lens Scripting API
    Preparing search index...

    Class OverlapProbeOptions

    Options supplied when creating an OverlapProbe. Optional; omitting it (or any field) uses the defaults.

    Lens Scripting Version 375

    const options = new SpecsInteractionModule.OverlapProbeOptions();
    options.trackDistances = true;
    const queryMask = LayerSet.all();
    const probe = interaction.createSphereOverlapProbe(script.getSceneObject(), 5, 6, queryMask, options);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    trackDistances

    Methods

    getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    trackDistances: boolean

    When enabled, the probe refreshes SpecsInteractionModule.Overlap#distance on each member once per frame with the closest-point distance from the collider's volume to the probe center; when disabled (the default), distance stays -1. Costs one closest-point solve per member per frame in the interaction service, so enable it only on probes whose distances you read, and avoid it on probes that can hold many members.

    Lens Scripting Version 375

    false

    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

    Constructors
    Properties
    Methods