Phaser API Documentation

  Version: 
Filter
This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . GameObjects . UpdateList

This is a beta release of our new docs system. Found an issue?
Please tell us about it in the #📖-newdocs-feedback channel on the Phaser Discord

Phaser . GameObjects . UpdateList

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, for Rendering.

Constructor:

new UpdateList(scene)

Parameters:

name type description
scene Phaser.Scene

The Scene that the Update List belongs to.

Since: 3.0.0

Extends


Members

<private> _active: Array.<*>
Focus
Focus

Description:

The active list is a selection of items which are considered active and should be updated.

Type:
Array.<*>
Default: []
Since: 3.20.0
Focus
Focus
<private> _destroy: Array.<*>
Focus
Focus

Description:

The destroy list is a selection of items that were active and are awaiting being destroyed in the next update.

Type:
Array.<*>
Default: []
Since: 3.20.0
Focus
Focus
<private> _pending: Array.<*>
Focus
Focus

Description:

The pending list is a selection of items which are due to be made 'active' in the next update.

Type:
Array.<*>
Default: []
Since: 3.20.0
Focus
Focus
<private> _toProcess: number
Focus
Focus

Description:

The total number of items awaiting processing.

Type:
number
Default: 0
Since: 3.0.0
Focus
Focus
scene: Phaser.Scene
Focus
Focus

Description:

The Scene that the Update List belongs to.

Type:
Since: 3.0.0
Focus
Focus

Description:

The Scene's Systems.

Type:
Since: 3.0.0
Focus
Focus

Methods

<private> boot()
Focus
Focus

Description:

This method is called automatically, only once, when the Scene is first created. Do not invoke it directly.

Examples:
Since: 3.5.1
Focus
Focus
destroy()
Focus
Focus

Description:

The Scene that owns this plugin is being destroyed.

We need to shutdown and then kill off all external references.

Examples:
Since: 3.0.0
Focus
Focus
sceneUpdate(time, delta)
Focus
Focus

Description:

The update step.

Pre-updates every active Game Object in the list.

Parameters:

name type description
time number

The current timestamp.

delta number

The delta time elapsed since the last frame.

Examples:
Since: 3.20.0
Focus
Focus
shutdown()
Focus
Focus

Description:

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.

Examples:
Since: 3.0.0
Focus
Focus
<private> start()
Focus
Focus

Description:

This method is called automatically by the Scene when it is starting up. It is responsible for creating local systems, properties and listening for Scene events. Do not invoke it directly.

Examples:
Since: 3.5.0
Focus
Focus