Class OnDisableEvent

Triggered when the ScriptComponent this event is bound to is disabled.

Example

script.createEvent("OnDisableEvent").bind(function(){
    print("Component Disabled");
})

Hierarchy (View Summary, Expand)

Constructors

constructor

Properties

enabled

Methods

bind getTypeName isOfType isSame

Constructors

Protectedconstructor

Properties

enabled

enabled: boolean

If true, the event is able to trigger. If false, the event will not trigger.

Methods

bind

  • bind(evCallback: (arg1: this) => void): void

    Binds a callback function to this event.

    Parameters

    • evCallback: (arg1: this) => void

    Returns void

getTypeName

  • getTypeName(): string

    Returns the typename of the SceneEvent.

    Returns string

isOfType

  • isOfType(type: string): boolean

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

    Parameters

    • type: string

    Returns boolean

isSame

  • isSame(other: ScriptObject): boolean

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR