Lens Scripting API
    Preparing search index...

    Class SceneEvent

    The base class for scenewide events. SceneEvents can be created using ScriptComponent's ScriptComponent#createEvent method.

    Script Events guide.

    You can bind to events in JavaScript:

    // Bind a function to the MouthOpened event
    function onMouthOpen(eventData)
    {
    print("mouth was opened");
    }
    var event = script.createEvent("MouthOpenedEvent");
    event.bind(onMouthOpen);
    // Print text 1 second later
    function delayedResponse(eventData)
    {
    print("Printed 1 second later.");
    }
    var event = script.createEvent("DelayedCallbackEvent");
    event.bind(delayedResponse);
    event.reset(1);

    You can also bind to events in TypeScript:

    // Print current elapsed Lens time every frame update.
    @component
    export class NewScript extends BaseScriptComponent {
    onAwake() {
    let event = this.createEvent('UpdateEvent');
    // Bind the function printTime to the event UpdateEvent
    event.bind(this.printTime.bind(this));
    }

    printTime(eventData: UpdateEvent) {
    // Print the elapsed Lens time
    print(getTime().toString());
    }
    }

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    Methods

    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 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

    MMNEPVFCICPMFPCPTTAAATR