DelayedCallbackEvent

Lens Studio v1.0.0+

Scripting Name: DelayedCallbackEvent

Inherits from SceneEvent

Description

An event that gets triggered after a delay.

Methods

---

getDelayTime() : Number

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

---

getTimeLeft() : Number

Returns the current time in seconds left in the event’s delay.

---

reset(Number time) : void

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

Inherited Methods

---

bind(function evCallback) : void

Binds a callback function to this event.

---

getTypeName() : String

Returns the typename of the SceneEvent.

---

getTypeName() : String

Returns the name of this object’s type.

---

isOfType(String type) : Boolean

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

---

isSame(ScriptObject other) : Boolean

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

Inherited Properties

---

enabled : Boolean

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

Examples

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