UpdateList
The Update List is a Scene plugin that maintains the list of Game Objects whose preUpdate method should be called every frame. Game Objects like Sprites add themselves to the Update List automatically so their animations are processed. You do not normally interact with the Update List directly; instead use addToUpdateList and removeFromUpdateList on individual Game Objects.
Constructor
new UpdateList(scene)
Parameters
| name | type | optional | description |
|---|---|---|---|
| scene | Phaser.Scene | No | The 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 shut down and then clear 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:
| name | type | optional | description |
|---|---|---|---|
| time | number | No | The current timestamp. |
| delta | number | No | The 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 destroy all active, pending, and queued Game Objects, reset all internal properties, and stop listening to Scene events.
Source: src/gameobjects/UpdateList.js#L161
Since: 3.0.0