Preparing search index...

    Class OnDisableEvent

    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.

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

    Hierarchy (View Summary)

    Index

    Properties

    enabled: boolean

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

    Methods

    • Binds a callback function to this event.

      Parameters

      • evCallback: (arg1: this) => void

      Returns void

    • Returns the typename of the SceneEvent.

      Returns string

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

      Parameters

      • type: string

      Returns 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