OnDestroyEvent
ClassEvent that runs when a Component will be destroyed.
- Available on all platforms
Since Lens Scripting v170
Event that runs when a Component will be destroyed. All OnDestroy events will run prior to any SceneObjects or Components actually being destroyed, however it is disallowed to reparent a SceneObject either under the SceneObject being destroyed or out from under a SceneObject being destroyed. Destroying an ancestor or descendent SceneObject during OnDestroy will queue that destruction to only be processed once the current destruction completes.
Index
Properties
Methods
Example
script.createEvent("OnDestroyEvent").bind(function(){
// Clean up objects
})
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<OnDestroyEvent>
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<OnDestroyEvent>
Since
Lens Scripting Version 170
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