Lens Scripting API
    Preparing search index...

    Class InteractableOptions

    Options supplied when registering an interactable.

    Lens Scripting Version 375

    const options = new SpecsInteractionModule.InteractableOptions();
    options.targetingMode = SpecsInteractionModule.TargetingMode.DirectIndirect;
    interaction.registerInteractable(script.getSceneObject(), [collider], options);
    Index

    Constructors

    constructor

    Properties

    ignoreInteractionPlane includeCollidersInPhysics layerMask targetingMode targetingPriority targetingVisual

    Methods

    getTypeName

    Constructors

    Properties

    ignoreInteractionPlane: boolean

    When enabled, this Interactable ignores any parent InteractionPlane and factors into the cursor's position and targetingVisual. Use when the Interactable is parented for organization but not spatially within that plane.

    Lens Scripting Version 375

    false
    includeCollidersInPhysics: boolean

    When enabled, this Interactable's colliders also participate in Lens Studio Physics: they collide with physics bodies and respond to Physics raycasts and overlap/collision events. Off by default; leave off when the colliders are only used for interaction to keep them out of the physics simulation.

    Lens Scripting Version 375

    false
    layerMask: LayerSet

    The layers this Interactable belongs to. A cast or probe hits it only when its queryMask shares a layer with this set, so an empty set makes the Interactable unhittable. Defaults to every supported layer, making the Interactable visible to all queries.

    Only layers 0-63 are supported. Higher layers are ignored, including any from LayerSet.makeUnique, which never fall in that range.

    Lens Scripting Version 375

    LayerSet.all()
    targetingMode: number

    How an interactor can interact with this Interactable, as a SpecsInteractionModule.TargetingMode bitmask. Combine bits with |.

    Lens Scripting Version 375

    SpecsInteractionModule.TargetingMode.DirectIndirect
    targetingPriority: TargetingPriority

    Targeting priority for this Interactable. Higher-priority Interactables are preferred over closer, lower-priority ones when an interactor targets.

    Lens Scripting Version 375

    SpecsInteractionModule.TargetingPriority.Normal
    targetingVisual: SpecsInteractionModule.TargetingVisual

    The targeting visual shown while an interactor targets this Interactable.

    Lens Scripting Version 375

    SpecsInteractionModule.TargetingVisual.Cursor

    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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods