Interface SnapRecordStartEvent

Gets called when the user starts long pressing the capture button to record a Snap.

Example

// @input SceneObject objectToShowOnRecord
script.createEvent("SnapRecordStartEvent").bind(function() {
    script.objectToShowOnRecord.enabled = true;
});
interface SnapRecordStartEvent {
    enabled: boolean;
    bind(evCallback: ((arg1: this) => void)): void;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

enabled

Methods

bind getTypeName isOfType isSame

Properties

enabled

enabled: boolean

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

Methods

bind

  • bind(evCallback): void

  • Binds a callback function to this event.

    Parameters

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

        • Parameters

          • arg1: this

          Returns void

    Returns void

getTypeName

  • getTypeName(): string

  • Returns the typename of the SceneEvent.

    Returns string

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other): 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