Class PokemonPhasePriorityQueue<T>

A generic speed-based priority queue of DynamicPhases

Type Parameters

T extends DynamicPhase

Hierarchy (View Summary)

PriorityQueue<T>
- PokemonPhasePriorityQueue
  - MovePhasePriorityQueue
  - PostSummonPhasePriorityQueue

Index

Constructors

Properties

Methods

clear find has isEmpty pop push remove reorder

Constructors

constructor

new PokemonPhasePriorityQueue<T extends DynamicPhase>(): PokemonPhasePriorityQueue<
T,
>
Type Parameters
- T extends DynamicPhase
Returns PokemonPhasePriorityQueue<T>
Inherited from PriorityQueue.constructor

Properties

`Protected`queue

queue: T[] = []

`Protected`setOrder

setOrder: undefined | BattlerIndex[]

Methods

clear

clear(): void
Sealed
Removes all elements from the queue

Returns void
Inherited from PriorityQueue.clear
- Defined in src/queues/priority-queue.ts:40

find

find(condition?: (t: T) => boolean): undefined | T
Parameters
- Optionalcondition: (t: T) => boolean
Returns undefined | T
An element matching the condition function
Inherited from PriorityQueue.find
- Defined in src/queues/priority-queue.ts:70

has

has(condition?: (t: T) => boolean): boolean
Parameters
- Optionalcondition: (t: T) => boolean
Returns boolean
Whether an element matching the condition function exists
Inherited from PriorityQueue.has
- Defined in src/queues/priority-queue.ts:75

isEmpty

isEmpty(): boolean
Sealed
Returns boolean
Whether the queue is empty
Inherited from PriorityQueue.isEmpty
- Defined in src/queues/priority-queue.ts:48

pop

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

Returns undefined | T
The front element of the queue after sorting, or undefined if the queue is empty
Inherited from PriorityQueue.pop
- Defined in src/queues/priority-queue.ts:19

push

push(element: T): void
Adds an element to the queue
Parameters
- element: T
  The element to add
Returns void
Inherited from PriorityQueue.push
- Defined in src/queues/priority-queue.ts:32

remove

remove(condition?: (t: T) => boolean): boolean
Removes the first element matching the condition
Parameters
- condition: (t: T) => boolean = ...
  An optional condition function (defaults to a function that always returns true)
Returns boolean
Whether a removal occurred
Inherited from PriorityQueue.remove
- Defined in src/queues/priority-queue.ts:57

`Protected`reorder

reorder(): void
Sorts the elements in the queue

Returns void
Overrides PriorityQueue.reorder
- Defined in src/queues/pokemon-phase-priority-queue.ts:9