Class RunHistory<T>

Type Parameters

T

Index

Constructors

Methods

all clear ranked record

Constructors

constructor

new RunHistory<T>(options: RunHistoryOptions): RunHistory<T>
Type Parameters
- T
Parameters
- options: RunHistoryOptions
Returns RunHistory<T>
- Defined in src/core/RunHistory.ts:44

Methods

all

all(): readonly RunHistoryEntry<T>[]
every recorded run, oldest first

Returns readonly RunHistoryEntry<T>[]
- Defined in src/core/RunHistory.ts:67

clear

clear(): void
drops every recorded run

Returns void
- Defined in src/core/RunHistory.ts:83

ranked

ranked(
by: (summary: T) => number,
order?: "asc" | "desc",
): readonly RunHistoryEntry<T>[]
Every recorded run sorted by a field of its own summary - explicitly a local, personal ranking over this player's own history, not a networked leaderboard comparing players against each other, which mwg does not attempt here.
Parameters
- by: (summary: T) => number
- order: "asc" | "desc" = 'desc'
Returns readonly RunHistoryEntry<T>[]
- Defined in src/core/RunHistory.ts:76

record

record(summary: T): RunHistoryEntry<T>
appends a completed run's summary, oldest first; drops the oldest entry once limit is exceeded
Parameters
- summary: T
Returns RunHistoryEntry<T>
- Defined in src/core/RunHistory.ts:57