DelayedCallbackEvent
ClassAn event that gets triggered after a delay.
- Available on all platforms
Index
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");
Extends
Properties
enabled
enabled:
boolean
If true, the event is able to trigger. If false, the event will not trigger.
Default Value
true
Inherited from
Methods
bind()
bind(
evCallback):void
Binds a callback function to this event.
Parameters
| Parameter | Type |
|---|---|
evCallback | (arg1) => void |
Returns
void
Inherited from
cancel()
cancel():
void
Cancel the callback in progress.
Returns
void
Since
Lens Scripting Version 266
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()
staticgetTypeName():TypeName<DelayedCallbackEvent>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<DelayedCallbackEvent>
Overrides
getTypeName()
getTypeName():
string
Returns the typename of the SceneEvent.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
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
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean
Inherited from
reset()
reset(
time):void
Calling this will cause the event to trigger in time seconds.
Parameters
| Parameter | Type |
|---|---|
time | number |
Returns
void