phaser - v4.0.0-rc.4
    Preparing search index...

    The Update List plugin.

    Update Lists belong to a Scene and maintain the list Game Objects to be updated every frame.

    Some or all of these Game Objects may also be part of the Scene's [Display List]Phaser.GameObjects.DisplayList, for Rendering.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    checkQueue: boolean

    If true only unique objects will be allowed in the queue.

    length: number

    The number of entries in the active list.

    scene: Scene

    The Scene that the Update List belongs to.

    systems: Systems

    The Scene's Systems.

    Methods

    • Add a listener for a given event.

      Parameters

      • event: string | symbol

        The event name.

      • fn: Function

        The listener function.

      • Optionalcontext: any

        The context to invoke the listener with. Default this.

      Returns this

    • Calls each of the listeners registered for a given event.

      Parameters

      • event: string | symbol

        The event name.

      • ...args: any[]

        Additional arguments that will be passed to the event handler.

      Returns boolean

    • Return the number of listeners listening to a given event.

      Parameters

      • event: string | symbol

        The event name.

      Returns number

    • Return the listeners registered for a given event.

      Parameters

      • event: string | symbol

        The event name.

      Returns Function[]

    • Remove the listeners of a given event.

      Parameters

      • event: string | symbol

        The event name.

      • Optionalfn: Function

        Only remove the listeners that match this function.

      • Optionalcontext: any

        Only remove the listeners that have this context.

      • Optionalonce: boolean

        Only remove one-time listeners.

      Returns this

    • Add a listener for a given event.

      Parameters

      • event: string | symbol

        The event name.

      • fn: Function

        The listener function.

      • Optionalcontext: any

        The context to invoke the listener with. Default this.

      Returns this

    • Add a one-time listener for a given event.

      Parameters

      • event: string | symbol

        The event name.

      • fn: Function

        The listener function.

      • Optionalcontext: any

        The context to invoke the listener with. Default this.

      Returns this

    • Removes all active items from this Process Queue.

      All the items are marked as 'pending destroy' and fully removed in the next update.

      Returns this

    • Remove the listeners of a given event.

      Parameters

      • event: string | symbol

        The event name.

      • Optionalfn: Function

        Only remove the listeners that match this function.

      • Optionalcontext: any

        Only remove the listeners that have this context.

      • Optionalonce: boolean

        Only remove one-time listeners.

      Returns this

    • The update step.

      Pre-updates every active Game Object in the list.

      Parameters

      • time: number

        The current timestamp.

      • delta: number

        The delta time elapsed since the last frame.

      Returns void

    • The Scene that owns this plugin is shutting down.

      We need to kill and reset all internal properties as well as stop listening to Scene events.

      Returns void

    • Update this queue. First it will process any items awaiting destruction, and remove them.

      Then it will check to see if there are any items pending insertion, and move them to an active state. Finally, it will return a list of active items for further processing.

      Returns GameObject[]