Skip to main content

OnDisableEvent

Class

Event 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
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

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

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

SceneEvent.enabled

Methods

bind()

bind(evCallback): void

Binds a callback function to this event.

Parameters

ParameterType
evCallback(arg1) => void

Returns

void

Inherited from

SceneEvent.bind


getTypeName()

static getTypeName(): 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

SceneEvent.getTypeName


getTypeName()

getTypeName(): string

Returns the typename of the SceneEvent.

Returns

string

Inherited from

SceneEvent.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

SceneEvent.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

SceneEvent.isSame