Preparing search index...

    Class OnAwakeEvent

    Event that runs immediately when a Component is constructed or deserialized. Will run before a call like SceneObject.createComponent or ObjectPrefab.instantiate returns. When multiple Components are constructed together, such as during Scene loading or ObjectPrefab instantiation, OnAwake events will run in hierarchy order. If a Component is disabled in the hierarchy at those points -- including because its SceneObject is disabled -- then OnAwake will not run, and will instead run immediately the first time the Component is enabled.

    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