Class Advancement

Index

Constructors

Accessors

Methods

choice choose grant openTiers spend toJSON fromJSON

Constructors

constructor

new Advancement(track: AdvancementTrack): Advancement
Parameters
- track: AdvancementTrack
Returns Advancement
- Defined in src/actors/Advancement.ts:68

Accessors

points

get points(): number
unspent ledger points

Returns number
- Defined in src/actors/Advancement.ts:73

Methods

choice

choice(tierIndex: number): string | null
the option taken at a branch/capstone tier, or null when undecided
Parameters
- tierIndex: number
Returns string | null
- Defined in src/actors/Advancement.ts:130

choose

choose(tierIndex: number, optionId: string, level: number): void
Takes one option of an open branch/capstone tier - permanently. Throws for a points tier, a tier that has not opened yet, an unknown option, or a tier already decided, so a game cannot accidentally offer a choice twice.
Parameters
- tierIndex: number
- optionId: string
- level: number
Returns void
- Defined in src/actors/Advancement.ts:117

grant

grant(level: number): number
Opens every tier up to level, granting each newly opened points tier's points.
Parameters
- level: number
Returns number
how many points were granted - 0 when nothing new opened, so a game can tell "level up with no new tier" from a real unlock
- Defined in src/actors/Advancement.ts:92

openTiers

openTiers(level: number): number[]
tier indices whose threshold the given level has reached, in order
Parameters
- level: number
Returns number[]
- Defined in src/actors/Advancement.ts:78

spend

spend(points: number): boolean
spends ledger points; false, spending nothing, when the balance is short
Parameters
- points: number
Returns boolean
- Defined in src/actors/Advancement.ts:106

toJSON

toJSON(): { balance: number; choices: [number, string][]; grantedTiers: number }
Returns { balance: number; choices: [number, string][]; grantedTiers: number }
- Defined in src/actors/Advancement.ts:134

`Static`fromJSON

fromJSON(
    track: AdvancementTrack,
    data: {
        balance: number;
        choices: [number, string][];
        grantedTiers: number;
    },
): Advancement
rebuilds advancement from save data - the track itself is supplied fresh, the same as QuestLog definitions
Parameters
- track: AdvancementTrack
- data: { balance: number; choices: [number, string][]; grantedTiers: number }
Returns Advancement
- Defined in src/actors/Advancement.ts:139