Class 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");

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

enabled

Methods

bind cancel getDelayTime getTimeLeft getTypeName isOfType isSame reset

Constructors

Protectedconstructor

Properties

enabled

enabled: boolean

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

Methods

bind

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

    Binds a callback function to this event.

    Parameters

    • evCallback: (arg1: this) => 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: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

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

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

    Parameters

    • time: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR