OnDisableEvent
ClassEvent that runs when a Component becomes disabled, either directly via its own Component.enabled property or because its SceneObject becomes disabled.
- Available on all platforms
Since Lens Scripting v175
Event that runs when a Component becomes disabled, either directly via its own Component.enabled property or because its SceneObject becomes disabled. OnDisableEvent will run after the SceneObject's own SceneObject.onDisabled event property and will not run if some listener to that event enabled the SceneObject again. All of a SceneObject's Components then receive OnDisableEvent before child SceneObjects begin to receive SceneObject.onDisabled and OnDisableEvents.
Index
Properties
Methods
Example
script.createEvent("OnDisableEvent").bind(function(){
print("Component Disabled");
})
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<OnDisableEvent>
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<OnDisableEvent>
Since
Lens Scripting Version 175
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