Lens Scripting API
    Preparing search index...

    Class OnWillEnterSuspendedEvent

    Triggered when the Lens is about to enter the Suspended phase.

    This event fires before Scene resources are released for suspension. Use it to save lightweight script-owned state or stop work that should not continue while the Lens is suspended.

    Lens Scripting Version 364

    script.createEvent("OnWillEnterSuspendedEvent").bind(() => {
        print("Lens will enter Suspended phase");
    });

    Hierarchy (View Summary)

    Index

    Properties

    enabled

    Methods

    bind getTypeName isOfType isSame

    Properties

    enabled: boolean

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

    true

    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

    Properties
    Methods