Preparing search index...

    Class OnStartEvent

    Runs on the first frame a Component is enabled, at a later point than OnAwakeEvent but guaranteed within the first frame before rendering. For Components constructed because of a scripting call like SceneObject.createComponent or ObjectPrefab.instantiate the OnStart event will run after those functions have returned and the calling scope has exited. Relative order of OnStart events between multiple Components constructed together (such as in initial SceneLoading or ObjectPrefab instantiation) is not guaranteed.

    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