Description

Triggered when the lens turns off.

Example

// Prints "turn off" when the lens turns off
var event = script.createEvent("TurnOffEvent");
event.bind(function (eventData)
{
print("turn off");
});
interface TurnOffEvent {
    enabled: boolean;
    bind(evCallback): void;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

enabled: boolean

Description

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

Methods

  • Parameters

    • evCallback: ((arg1) => void)
        • (arg1): void
        • Parameters

          • arg1: this

          Returns void

    Returns void

    Description

    Binds a callback function to this event.

  • Returns string

    Description

    Returns the typename of the SceneEvent.

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Generated using TypeDoc