Class PhasePriorityQueue`Abstract`

Stores a list of Phases

Dynamically updates ordering to always pop the highest "priority", based on implementation of reorder

Hierarchy (View Summary)

PhasePriorityQueue
- PostSummonPhasePriorityQueue

Index

Constructors

Properties

Methods

clear pop push reorder tryRemovePhase

Constructors

constructor

new PhasePriorityQueue(): PhasePriorityQueue
Returns PhasePriorityQueue

Properties

`Protected` `Abstract`queue

queue: Phase[]

Methods

clear

clear(): void
Removes all phases from the queue

Returns void
- Defined in src/data/phase-priority-queue.ts:44

pop

pop(): undefined | Phase
Calls reorder and shifts the queue

Returns undefined | Phase
The front element of the queue after sorting
- Defined in src/data/phase-priority-queue.ts:28

push

push(phase: Phase): void
Adds a phase to the queue
Parameters
- phase: Phase
  The phase to add
Returns void
- Defined in src/data/phase-priority-queue.ts:37

`Abstract`reorder

reorder(): void
Sorts the elements in the queue

Returns void
- Defined in src/data/phase-priority-queue.ts:22

tryRemovePhase

tryRemovePhase(
phaseFilter: (phase: Phase) => boolean,
removeCount?: number | "all",
): number
Attempt to remove one or more Phases from the current queue.
Parameters
- phaseFilter: (phase: Phase) => boolean
  The function to select phases for removal
- removeCount: number | "all" = 1
  The maximum number of phases to remove, or all to remove all matching phases; default 1
Returns number
The number of successfully removed phases

Todo
Remove this eventually once the patchwork bug this is used for is fixed
- Defined in src/data/phase-priority-queue.ts:56