If true only unique objects will be allowed in the queue, preventing the same item from being added more than once.
ReadonlylengthThe number of entries in the active list.
Adds a new item to the Process Queue.
The item is added to the pending list and made active in the next update.
The item to add to the queue.
The item that was added.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Immediately destroys this process queue, clearing all of its internal arrays and resetting the process totals.
Calls each of the listeners registered for a given event.
The event name.
Additional arguments that will be passed to the event handler.
true if the event had listeners, else false.
Return an array listing the events for which the emitter has registered listeners.undefined
undefined
Returns the current list of active items.
This method returns a reference to the active list array, not a copy of it. Therefore, be careful to not modify this array outside of the ProcessQueue.undefined
A list of active items.
Checks the given item to see if it is already active within this Process Queue.
The item to check.
true if the item is active, otherwise false.
Checks the given item to see if it is already pending destruction from this Process Queue.
The item to check.
true if the item is pending destruction, otherwise false.
Checks the given item to see if it is already pending addition to this Process Queue.
The item to check.
true if the item is pending insertion, otherwise false.
Return the number of listeners listening to a given event.
The event name.
The number of listeners.
Return the listeners registered for a given event.
The event name.
The registered listeners.
Remove the listeners of a given event.
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.
this.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Add a one-time listener for a given event. The listener is automatically removed the first time the event is emitted, so it will never be called more than once.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Removes an item from the Process Queue.
The item is added to the 'destroy' list and is fully removed in the next update.
The item to be removed from the queue.
The item that was removed.
Removes all active items from this Process Queue.
All the items are marked as 'pending destroy' and fully removed in the next update.undefined
This Process Queue object.
Remove all listeners, or those of the specified event.
Optionalevent: string | symbol
The event name.
this.
Remove the listeners of a given event.
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.
this.
Removes all listeners from this EventEmitter. This method is called automatically by the Scene Systems when the parent Scene shuts down, ensuring that all event bindings are cleared and no stale references remain.
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.undefined
A list of active items.
A Process Queue maintains three internal lists.
The
pendinglist is a selection of items which are due to be made 'active' in the next update. Theactivelist is a selection of items which are considered active and should be updated. Thedestroylist is a selection of items that were active and are awaiting being destroyed in the next update.When new items are added to a Process Queue they are put in the pending list, rather than being added immediately to the active list. Equally, items that are removed are put into the destroy list, rather than being destroyed immediately. This allows the Process Queue to carefully process each item at a specific, fixed time, rather than at the time of the request from the API.
Process Queue is used extensively within Phaser to safely manage collections of objects such as Cameras, Plugins, and Scene Systems, where items may be added or removed during an active update loop. By deferring additions and removals to a controlled point between updates, it avoids the bugs that would result from modifying a list while it is being iterated over.
The queue extends EventEmitter and fires
Phaser.Structs.Events#PROCESS_QUEUE_ADDwhen an item becomes active andPhaser.Structs.Events#PROCESS_QUEUE_REMOVEwhen an item is removed.