OnStartEvent
ClassRuns on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering.
- Available on all platforms
Since Lens Scripting v146
Runs on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering. For Components constructed because of a scripting call like SceneObject.createComponent or ObjectPrefab.instantiate the OnStart event will run after those functions have returned and the calling scope has exited. Relative order of OnStart events between multiple Components constructed together (such as in initial SceneLoading or ObjectPrefab instantiation) is not guaranteed.
Index
Properties
Methods
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<OnStartEvent>
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<OnStartEvent>
Since
Lens Scripting Version 146
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