Interface DelayedCallbackEvent

An event that gets triggered after a delay.

Example

// Wait for 2 seconds before executing a function
var delayedEvent = script.createEvent("DelayedCallbackEvent");
delayedEvent.bind(function(eventData)
{
    print("delay is over");
});

// Start with a 2 second delay
delayedEvent.reset(2);
print("delay has started");
interface DelayedCallbackEvent {
    enabled: boolean;
    bind(evCallback: ((arg1: this) => void)): void;
    cancel(): void;
    getDelayTime(): number;
    getTimeLeft(): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    reset(time: number): void;
}

Hierarchy (view full)

Properties

enabled

Methods

bind cancel getDelayTime getTimeLeft getTypeName isOfType isSame reset

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

cancel

  • cancel(): void

  • Cancel the callback in progress.

    Returns void

getDelayTime

  • getDelayTime(): number

  • Returns the total delay time in seconds set on the event.

    Returns number

getTimeLeft

  • getTimeLeft(): number

  • Returns the current time in seconds left in the event's delay.

    Returns number

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

reset

  • reset(time): void

  • Calling this will cause the event to trigger in time seconds.

    Parameters

    • time: number

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods