If true only unique objects will be allowed in the queue.
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.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default 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.
Return an array listing the events for which the emitter has registered listeners.
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.
Checks the given item to see if it is already active within this Process Queue.
The item to check.
Checks the given item to see if it is already pending destruction from this Process Queue.
The item to check.
Checks the given item to see if it is already pending addition to this Process Queue.
The item to check.
Return the number of listeners listening to a given event.
The event name.
Return the listeners registered for a given event.
The event name.
Remove the listeners of a given event.
The event name.
Optionalfn: FunctionOnly remove the listeners that match this function.
Optionalcontext: anyOnly remove the listeners that have this context.
Optionalonce: booleanOnly remove one-time listeners.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default this.
Add a one-time listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default 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.
Removes all active items from this Process Queue.
All the items are marked as 'pending destroy' and fully removed in the next update.
Remove all listeners, or those of the specified event.
Optionalevent: string | symbolThe event name.
Remove the listeners of a given event.
The event name.
Optionalfn: FunctionOnly remove the listeners that match this function.
Optionalcontext: anyOnly remove the listeners that have this context.
Optionalonce: booleanOnly remove one-time listeners.
Removes all listeners.
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.
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 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.