OnAwakeEvent
ClassEvent that runs immediately when a Component is constructed or deserialized.
- Available on all platforms
Since Lens Scripting v146
Event that runs immediately when a Component is constructed or deserialized. Will run before a call like SceneObject.createComponent or ObjectPrefab.instantiate returns. When multiple Components are constructed together, such as during Scene loading or ObjectPrefab instantiation, OnAwake events will run in hierarchy order. If a Component is disabled in the hierarchy at those points -- including because its SceneObject is disabled -- then OnAwake will not run, and will instead run immediately the first time the Component is enabled.
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<OnAwakeEvent>
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<OnAwakeEvent>
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