Skip to main content
Version: Phaser v4.0.0-rc.6

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

nametypeoptionaldescription
scenePhaser.SceneNoThe Scene that the Update List belongs to.

Scope: static

Extends

Phaser.Structs.ProcessQueue.<Phaser.GameObjects.GameObject>

Source: src/gameobjects/UpdateList.js#L12
Since: 3.0.0

Public Members

scene

scene: Phaser.Scene

Description:

The Scene that the Update List belongs to.

Source: src/gameobjects/UpdateList.js#L41
Since: 3.0.0


systems

systems: Phaser.Scenes.Systems

Description:

The Scene's Systems.

Source: src/gameobjects/UpdateList.js#L50
Since: 3.0.0


Public Methods

destroy

<instance> destroy()

Description:

The Scene that owns this plugin is being destroyed.

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

Source: src/gameobjects/UpdateList.js#L207
Since: 3.0.0


sceneUpdate

<instance> sceneUpdate(time, delta)

Description:

The update step.

Pre-updates every active Game Object in the list.

Parameters:

nametypeoptionaldescription
timenumberNoThe current timestamp.
deltanumberNoThe delta time elapsed since the last frame.

Source: src/gameobjects/UpdateList.js#L134
Since: 3.20.0


shutdown

<instance> shutdown()

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.

Source: src/gameobjects/UpdateList.js#L161
Since: 3.0.0