OnTimeStartEvent
ClassThe base class for scenewide events.
- Available on all platforms
The base class for scenewide events. SceneEvents can be created using ScriptComponent's ScriptComponent#createEvent method.
Index
Properties
Methods
Example
You can bind to events in JavaScript:
// Bind a function to the MouthOpened event
function onMouthOpen(eventData)
{
print("mouth was opened");
}
var event = script.createEvent("MouthOpenedEvent");
event.bind(onMouthOpen);
// Print text 1 second later
function delayedResponse(eventData)
{
print("Printed 1 second later.");
}
var event = script.createEvent("DelayedCallbackEvent");
event.bind(delayedResponse);
event.reset(1);
You can also bind to events in TypeScript:
// Print current elapsed Lens time every frame update.
@component
export class NewScript extends BaseScriptComponent {
onAwake() {
let event = this.createEvent('UpdateEvent');
// Bind the function printTime to the event UpdateEvent
event.bind(this.printTime.bind(this));
}
printTime(eventData: UpdateEvent) {
// Print the elapsed Lens time
print(getTime().toString());
}
}
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
getTypeName()
staticgetTypeName():TypeName<OnTimeStartEvent>
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<OnTimeStartEvent>
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
See also
Script Events guide.