Class default<T>

Type Parameters

T extends IStatHost

Hierarchy

default

Constructors

constructor

new default<T>(host: T): default<T>
Type Parameters
- T extends IStatHost<T>
Parameters
- host: T
Returns default<T>
- Defined in src/game/game/entity/Stats.ts:38

Methods

all

all(): IStatBase[]
Returns IStatBase[]
- Defined in src/game/game/entity/Stats.ts:413

exceedsMax

exceedsMax(stat: IStat | Stat): boolean
Returns whether the stat exceeds its max value. If there is no max for this stat, returns false.
Parameters
- stat: IStat | Stat
Returns boolean
- Defined in src/game/game/entity/Stats.ts:304

get

get<STAT_DATA>(stat: IStat | Stat, allowFailure?: boolean): STAT_DATA & (STAT_DATA extends IStatBase ? {
base: STAT_DATA;
} : undefined)
Returns the stat object of a given Stat. The return type is a vague IStat, but can be passed a type which extends IStatBase for automatic narrowing.
Type Parameters
- STAT_DATA extends undefined | IStatBase = undefined | IStat
Parameters
- stat: IStat | Stat
  
  The Stat to get
- allowFailure: boolean = false
Returns STAT_DATA & (STAT_DATA extends IStatBase ? {
base: STAT_DATA;
} : undefined)
- Defined in src/game/game/entity/Stats.ts:97

getBaseMax

getBaseMax(stat: IStat | Stat, allowFailure?: boolean): undefined | number
Returns the max of the given stat, or undefined if the stat isn't an IStatMax. Stat bonus is not applied.
Parameters
- stat: IStat | Stat
- allowFailure: boolean = false
Returns undefined | number
- Defined in src/game/game/entity/Stats.ts:266

getBaseValue

getBaseValue(stat: IStat | Stat, allowFailure?: boolean): undefined | number
Returns the value of the given stat, or undefined if the stat does not exist. Stat bonus is not applied.
Parameters
- stat: IStat | Stat
- allowFailure: boolean = false
Returns undefined | number
- Defined in src/game/game/entity/Stats.ts:123

getBonus

getBonus(stat: IStat | Stat): undefined | number
Parameters
- stat: IStat | Stat
Returns undefined | number
- Defined in src/game/game/entity/Stats.ts:204

getMax

getMax(stat: IStat | Stat): number
Returns the max of the given stat, or undefined if the stat isn't an IStatMax. Stat bonus is applied.
Parameters
- stat: IStat | Stat
Returns number
- Defined in src/game/game/entity/Stats.ts:257

getPercent

getPercent(stat: IStat | Stat): number
Returns the "percent" of the given stat, calculated with value / max. If there is no max for this stat, returns undefined.
Parameters
- stat: IStat | Stat
Returns number
- Defined in src/game/game/entity/Stats.ts:295

getTimeUntilChange

getTimeUntilChange(stat: IStat | Stat, allowFailure?: boolean): number
Parameters
- stat: IStat | Stat
- Optional allowFailure: boolean
Returns number
- Defined in src/game/game/entity/Stats.ts:385

getValue

getValue(stat: IStat | Stat, allowFailure?: true): undefined | number
Returns the value of the given stat, or undefined if the stat does not exist. Stat bonus is applied.
Parameters
- stat: IStat | Stat
- Optional allowFailure: true
Returns undefined | number
- Defined in src/game/game/entity/Stats.ts:115

has

has(stat: IStat | Stat): boolean
Returns whether the given stat exists on this entity.
Parameters
- stat: IStat | Stat
Returns boolean
- Defined in src/game/game/entity/Stats.ts:78

hasMax

hasMax(stat: IStat | Stat): boolean
Returns whether the given stat has a max.
Parameters
- stat: IStat | Stat
Returns boolean
- Defined in src/game/game/entity/Stats.ts:249

increase

increase(stat: IStat | Stat, amount: number, info?: IStatChangeInfo<any> | StatChangeReason): boolean
Increases the given Stat by the given amount. Triggers statChange
Parameters
- stat: IStat | Stat
  
  The Stat to increase.
- amount: number
  
  The amount to increase by.
- Optional info: IStatChangeInfo<any> | StatChangeReason
Returns boolean
- Defined in src/game/game/entity/Stats.ts:198

increaseChangeTimer

increaseChangeTimer(stat: IStat | Stat, amt?: number): T
Increases the change timer for the given stat.
Parameters
- stat: IStat | Stat
  
  The stat to increase the change timer for.
- Optional amt: number
  
  The amount to increase the change timer by. Defaults to the stat's changeTimerSpeed.
Returns T
- Defined in src/game/game/entity/Stats.ts:380

init

init(stat: Stat, initializer?: ((factory: default) => any)): T
Initializes the given stat from a StatFactory instance.
Parameters
- stat: Stat
- Optional initializer: ((factory: default) => any)
  - - (factory: default): any
    - Parameters
      
      factory: default
      
      Returns any
Returns T
- Defined in src/game/game/entity/Stats.ts:57
init(stat: Stat, value: number, initializer?: ((factory: default) => any)): T
Parameters
- stat: Stat
- value: number
- Optional initializer: ((factory: default) => any)
  - - (factory: default): any
    - Parameters
      
      factory: default
      
      Returns any
Returns T
- Defined in src/game/game/entity/Stats.ts:58

reduce

reduce(stat: IStat | Stat, amount: number, info?: IStatChangeInfo<any> | StatChangeReason): boolean
Reduces the given Stat by the given amount. Triggers statChange
Parameters
- stat: IStat | Stat
  
  The Stat to reduce.
- amount: number
  
  The amount to reduce by.
- Optional info: IStatChangeInfo<any> | StatChangeReason
Returns boolean
- Defined in src/game/game/entity/Stats.ts:186

reduceChangeTimer

reduceChangeTimer(stat: IStat | Stat, amt?: number): T
Decreases the change timer for the given stat.
Parameters
- stat: IStat | Stat
  
  The stat to decrease the change timer for.
- Optional amt: number
  
  The amount to decrease the change timer by. Defaults to the stat's changeTimerSpeed.
Returns T
- Defined in src/game/game/entity/Stats.ts:346

remove

remove(stat: IStat | Stat): T
Removes the given stat from this entity.
Parameters
- stat: IStat | Stat
Returns T
- Defined in src/game/game/entity/Stats.ts:86

removeChangeTimer

removeChangeTimer(stat: IStat | Stat): T
Parameters
- stat: IStat | Stat
Returns T
- Defined in src/game/game/entity/Stats.ts:391

resetChangeTimer

resetChangeTimer(stat: IStat | Stat): T
Resets the change timer for the given stat.
Parameters
- stat: IStat | Stat
  
  The stat to reset the change timer for.
Returns T
- Defined in src/game/game/entity/Stats.ts:332

set

set(stat: IStat | Stat, amount: number, info?: IStatChangeInfo<any> | StatChangeReason): boolean
Sets the given Stat's value to the given amount. Assumes the given value includes any bonus. Triggers statChange
Parameters
- stat: IStat | Stat
  
  The Stat to set.
- amount: number
  
  The amount to set the value to, including the bonus.
- info: IStatChangeInfo<any> | StatChangeReason = StatChangeReason.Normal
Returns boolean
- Defined in src/game/game/entity/Stats.ts:135

setBonus

setBonus(stat: IStat | Stat, bonus: number, info?: IStatChangeInfo<any> | StatChangeReason): T
Change the bonus for a stat.
Parameters
- stat: IStat | Stat
  
  The Stat to set the bonus of.
- bonus: number
  
  The amount to increase/decrease the stat.
- Optional info: IStatChangeInfo<any> | StatChangeReason
Returns T
- Defined in src/game/game/entity/Stats.ts:216

setChangeTimer

setChangeTimer(stat: IStat | Stat, timer: number, initializer?: ((factory: StatChangeTimerFactory) => any)): T
Sets how frequently the stat should change. Triggers statTimerChange
Parameters
- stat: IStat | Stat
  
  The Stat that should change.
- timer: number
  
  How many turns should pass between changes.
- Optional initializer: ((factory: StatChangeTimerFactory) => any)
  - - (factory: StatChangeTimerFactory): any
    - Parameters
      
      factory: StatChangeTimerFactory
      
      Returns any
Returns T
- Defined in src/game/game/entity/Stats.ts:320

setMax

setMax(stat: IStat | Stat, max: number, newValue?: number): T
Sets the given Stat's max to the given amount. Triggers statMaxChange
Parameters
- stat: IStat | Stat
  
  The Stat to set.
- max: number
  
  The amount to set the value to.
- Optional newValue: number
  
  The new value for the stat, optional. Calls Stat.set internally.
Returns T
- Defined in src/game/game/entity/Stats.ts:276

setValue

setValue(stat: IStat | Stat, amount: number, info?: IStatChangeInfo<any> | StatChangeReason): boolean
Sets the given Stat's value to the given amount. Triggers statChange
Parameters
- stat: IStat | Stat
  
  The Stat to set.
- amount: number
  
  The amount to set the value to.
- info: IStatChangeInfo<any> | StatChangeReason = StatChangeReason.Normal
Returns boolean
- Defined in src/game/game/entity/Stats.ts:155

updateTimers

updateTimers(): default<T>
Passes the "turn" for stats, decrements their changeTimers. If a stat's timer reaches 0, the stat value is changed by changeAmount and the changeTimer is reset to nextChangeTimer

Returns default<T>
- Defined in src/game/game/entity/Stats.ts:407

Class default<T>

Type Parameters

T extends IStatHost

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

T extends IStatHost<T>

Parameters

host: T

Returns default<T>

Methods

all

Returns IStatBase[]

exceedsMax

Parameters

stat: IStat | Stat

Returns boolean

get

Type Parameters

STAT_DATA extends undefined | IStatBase = undefined | IStat

Parameters

stat: IStat | Stat

allowFailure: boolean = false

Returns STAT_DATA & (STAT_DATA extends IStatBase ? { base: STAT_DATA; } : undefined)

getBaseMax

Parameters

stat: IStat | Stat

allowFailure: boolean = false

Returns undefined | number

getBaseValue

Parameters

stat: IStat | Stat

allowFailure: boolean = false

Returns undefined | number

getBonus

Parameters

stat: IStat | Stat

Returns undefined | number

getMax

Parameters

stat: IStat | Stat

Returns number

getPercent

Parameters

stat: IStat | Stat

Returns number

getTimeUntilChange

Parameters

stat: IStat | Stat

Optional allowFailure: boolean

Returns number

getValue

Parameters

stat: IStat | Stat

Optional allowFailure: true

Returns undefined | number

has

Parameters

stat: IStat | Stat

Returns boolean

hasMax

Parameters

stat: IStat | Stat

Returns boolean

increase

Parameters

stat: IStat | Stat

amount: number

Optional info: IStatChangeInfo<any> | StatChangeReason

Returns boolean

increaseChangeTimer

Parameters

stat: IStat | Stat

Optional amt: number

Returns T

init

Returns STAT_DATA & (STAT_DATA extends IStatBase ? {
base: STAT_DATA;
} : undefined)

`Optional` allowFailure: boolean

`Optional` allowFailure: true

`Optional` info: IStatChangeInfo<any> | StatChangeReason

`Optional` amt: number

`Optional` initializer: ((factory: default) => any)

`Optional` initializer: ((factory: default) => any)

`Optional` info: IStatChangeInfo<any> | StatChangeReason

`Optional` amt: number

`Optional` info: IStatChangeInfo<any> | StatChangeReason

`Optional` initializer: ((factory: StatChangeTimerFactory) => any)

`Optional` newValue: number