Lens Scripting API

    Class TurnOnEvent

    This event has been deprecated, please use the OnStartEvent instead.

    Triggered when the lens turns on.

    // Prints "turn on" when the lens starts
    var event = script.createEvent("TurnOnEvent");
    event.bind(function (eventData)
    {
    	print("turn on");
    });

    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