Lens Scripting API

    Class OnPauseEventWearable Only

    Triggered when users tap the menu button in Palm UI.

    When paused, certain behaviors like animations or script updates continue running in the background, while inputs (e.g., Hand Tracking, Mobile Controller) are disabled to allow the system overlay to take priority. Developers should manage scenarios where the Lens is paused to maintain a seamless experience.

    Example js

    script.createEvent("OnPauseEvent").bind(function (eventData)
    {
        print("Paused");
    });

    Example ts

    @component
    export class NewScript extends BaseScriptComponent {
      onAwake() {
        this.createEvent("OnPauseEvent").bind(() => {
          print("Paused");
        });
      }
    }

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    enabled

    Methods

    bind getTypeName isOfType isSame

    Constructors

    Properties

    enabled: boolean

    If true, the event is able to trigger. If false, the event will not trigger.

    Methods

    • Binds a callback function to this event.

      Parameters

      • evCallback: (arg1: this) => void

      Returns void

    • Returns the typename of the SceneEvent.

      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

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR