Class default

Hierarchy

InfoProvider
- default

Constructors

constructor

new default(magic: default): default
Parameters
- magic: default
Returns default
Overrides InfoProvider.constructor
- Defined in src/game/game/inspection/infoProviders/MagicalProperties.ts:37

Properties

`Protected` `Optional` component

component?: default<HTMLElement>

`Protected` `Optional` context

context?: InfoProviderContext

`Readonly` event

event: IEventEmitter<default, IInfoProviderEvents> = ...

`Static` multiTextParagraph

multiTextParagraph: string = "info-provider-multi-text-paragraph"

Methods

get

get(): default
Returns default
Overrides InfoProvider.get
- Defined in src/game/game/inspection/infoProviders/MagicalProperties.ts:62

getClass

getClass(): string[]
Returns string[]
Overrides InfoProvider.getClass
- Defined in src/game/game/inspection/infoProviders/MagicalProperties.ts:42

getDefaultDisplayLevel

getDefaultDisplayLevel(_context: InfoProviderContext): InfoDisplayLevel | Set<InfoDisplayLevel>
Parameters
- _context: InfoProviderContext
Returns InfoDisplayLevel | Set<InfoDisplayLevel>
Inherited from InfoProvider.getDefaultDisplayLevel
- Defined in src/game/game/inspection/InfoProvider.ts:175

getDisplayLevel

getDisplayLevel(context: InfoProviderContext): Set<InfoDisplayLevel>
Parameters
- context: InfoProviderContext
Returns Set<InfoDisplayLevel>
Inherited from InfoProvider.getDisplayLevel
- Defined in src/game/game/inspection/InfoProvider.ts:192

getIcon

getIcon(): {
    height: number;
    path: default<InfoIcon>;
    width: number;
}
Returns {
    height: number;
    path: default<InfoIcon>;
    width: number;
}
- height: number
- path: default<InfoIcon>
- width: number
Overrides InfoProvider.getIcon
- Defined in src/game/game/inspection/infoProviders/MagicalProperties.ts:46

hasContent

hasContent(): boolean
Returns boolean
Overrides InfoProvider.hasContent
- Defined in src/game/game/inspection/infoProviders/MagicalProperties.ts:58

init

init(): void
Returns void
Inherited from InfoProvider.init
- Defined in src/game/game/inspection/InfoProvider.ts:236

`Protected` initChildTextComponent

initChildTextComponent(text: TranslationGenerator): default
Parameters
- text: TranslationGenerator
Returns default
Inherited from InfoProvider.initChildTextComponent
- Defined in src/game/game/inspection/InfoProvider.ts:556

initComponent

initComponent(context: InfoProviderContext, component?: default<HTMLElement>, partial?: boolean, data?: {
    lastInfoSleep: number;
}): {
    component: default<HTMLElement>;
    fullInit(): void;
}
Parameters
- context: InfoProviderContext
- component: default<HTMLElement> = ...
- partial: boolean = false
- data: {
  lastInfoSleep: number;
  } = ...
  - lastInfoSleep: number
Returns {
component: default<HTMLElement>;
fullInit(): void;
}
- component: default<HTMLElement>
- fullInit:function
  - fullInit(): void
  - Returns void
    - Defined in src/game/game/inspection/InfoProvider.ts:550
Inherited from InfoProvider.initComponent
- Defined in src/game/game/inspection/InfoProvider.ts:338

onStoppingPlay

onStoppingPlay(): void
Returns void
Inherited from InfoProvider.onStoppingPlay
- Defined in src/game/game/inspection/InfoProvider.ts:332

recheckHasContent

recheckHasContent(): default
Call when this info provider should recheck whether it has contents.

Returns default
Inherited from InfoProvider.recheckHasContent
- Defined in src/game/game/inspection/InfoProvider.ts:311

refresh

refresh(): default
Call when this info provider should be refreshed.

Returns default
Inherited from InfoProvider.refresh
- Defined in src/game/game/inspection/InfoProvider.ts:303

refreshDisplayLevel

refreshDisplayLevel(): default
Call when this info provider should refresh its display level.

Returns default
Inherited from InfoProvider.refreshDisplayLevel
- Defined in src/game/game/inspection/InfoProvider.ts:319

remove

remove(): default
Call when this info provider should be removed.

Returns default
Inherited from InfoProvider.remove
- Defined in src/game/game/inspection/InfoProvider.ts:327

setComponent

setComponent(componentClass: Class<default<HTMLElement>, any[]>): default
Parameters
- componentClass: Class<default<HTMLElement>, any[]>
Returns default
Inherited from InfoProvider.setComponent
- Defined in src/game/game/inspection/InfoProvider.ts:205

setComponentInitializer

setComponentInitializer(initializer: ((componenent: default<HTMLElement>) => any)): default
Parameters
- initializer: ((componenent: default<HTMLElement>) => any)
  - - (componenent: default<HTMLElement>): any
    - Parameters
      
      componenent: default<HTMLElement>
      
      Returns any
Returns default
Inherited from InfoProvider.setComponentInitializer
- Defined in src/game/game/inspection/InfoProvider.ts:211

setDisplayLevel

setDisplayLevel(...displayLevel: (undefined | InfoDisplayLevel)[]): default
Parameters
- Rest ...displayLevel: (undefined | InfoDisplayLevel)[]
Returns default
Inherited from InfoProvider.setDisplayLevel
- Defined in src/game/game/inspection/InfoProvider.ts:179

setIcon

setIcon(icon?: string | IIcon): default
Parameters
- Optional icon: string | IIcon
Returns default
Inherited from InfoProvider.setIcon
- Defined in src/game/game/inspection/InfoProvider.ts:221

setSynchronous

setSynchronous(): default
Returns default
Inherited from InfoProvider.setSynchronous
- Defined in src/game/game/inspection/InfoProvider.ts:231

subscribeRefreshOn

subscribeRefreshOn<E>(emitterOrBus: E, ...events: (keyof Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>)[]): default
Marks this info provider as to subscribe refresh events to the given host.
Note: Any existing initialized components will not be retroactively subscribed.
Type Parameters
- E extends EmitterOrBus
Parameters
- emitterOrBus: E
- Rest ...events: (keyof Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>)[]
Returns default
Inherited from InfoProvider.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:251
subscribeRefreshOn<E, K>(emitter: WeakRef<E>, ...events: (keyof Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>)[]): default
Type Parameters
- E extends HostOrHostClass
- K extends string | number | symbol
Parameters
- emitter: WeakRef<E>
- Rest ...events: (keyof Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>)[]
Returns default
Inherited from InfoProvider.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:252
subscribeRefreshOn<E, K>(emitterOrBus: E, ...args: [...events: K[], predicate: ((...params: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>, ...args: Extract<LiterallyJustTheSameThing<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>>, any[]>[]]) => boolean)]): default
Marks this info provider as to subscribe refresh events to the given host.
Note: Any existing initialized components will not be retroactively subscribed.
Type Parameters
- E extends EmitterOrBus
- K extends string | number | symbol
Parameters
- emitterOrBus: E
- Rest ...args: [...events: K[], predicate: ((...params: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>, ...args: Extract<LiterallyJustTheSameThing<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>>, any[]>[]]) => boolean)]
Returns default
Inherited from InfoProvider.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:258
subscribeRefreshOn<E>(emitterOrBus: E, ...args: [...events: (keyof Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>)[], observer: Observer<any>]): default
Marks this info provider as to subscribe refresh events to the given host.
Note: Any existing initialized components will not be retroactively subscribed.
Type Parameters
- E extends EmitterOrBus
Parameters
- emitterOrBus: E
- Rest ...args: [...events: (keyof Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>)[], observer: Observer<any>]
Returns default
Inherited from InfoProvider.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:264

subscribeRefreshOnTick

subscribeRefreshOnTick(observer: Observer<any>): default
Parameters
- observer: Observer<any>
Returns default
Inherited from InfoProvider.subscribeRefreshOnTick
- Defined in src/game/game/inspection/InfoProvider.ts:241
subscribeRefreshOnTick(predicate: ((...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]) => boolean)): default
Parameters
- predicate: ((...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]) => boolean)
  - - (...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]): boolean
    - Parameters
      
      Rest ...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]
      
      Returns boolean
Returns default
Inherited from InfoProvider.subscribeRefreshOnTick
- Defined in src/game/game/inspection/InfoProvider.ts:242

`Static` create

create(...translations: TranslationGenerator[]): SimpleInfoProvider
Parameters
- Rest ...translations: TranslationGenerator[]
Returns SimpleInfoProvider
Inherited from InfoProvider.create
- Defined in src/game/game/inspection/InfoProvider.ts:94

`Static` description

description(...translations: (undefined | TranslationGenerator | InfoProvider)[]): SimpleInfoProvider
Parameters
- Rest ...translations: (undefined | TranslationGenerator | InfoProvider)[]
Returns SimpleInfoProvider
Inherited from InfoProvider.description
- Defined in src/game/game/inspection/InfoProvider.ts:126

`Static` dynamic

dynamic<T>(observer: Observer<T>, supplier: ((value: T) => undefined | InfoProvider)): SimpleInfoProvider
Type Parameters
- T
Parameters
- observer: Observer<T>
- supplier: ((value: T) => undefined | InfoProvider)
  - - (value: T): undefined | InfoProvider
    - Parameters
      
      value: T
      
      Returns undefined | InfoProvider
Returns SimpleInfoProvider
Inherited from InfoProvider.dynamic
- Defined in src/game/game/inspection/InfoProvider.ts:99

`Static` get

get(magic?: default | {
magic?: default;
}): undefined | default
Parameters
- Optional magic: default | {
  magic?: default;
  }
Returns undefined | default
- Defined in src/game/game/inspection/infoProviders/MagicalProperties.ts:32

`Static` getFireStageTranslation

getFireStageTranslation(decay?: number): undefined | default
Parameters
- Optional decay: number
Returns undefined | default
- Defined in src/game/game/inspection/infoProviders/MagicalProperties.ts:28

`Static` list

list(...translations: (undefined | TranslationGenerator | InfoProvider)[]): SimpleInfoProvider
Parameters
- Rest ...translations: (undefined | TranslationGenerator | InfoProvider)[]
Returns SimpleInfoProvider
Inherited from InfoProvider.list
- Defined in src/game/game/inspection/InfoProvider.ts:138

`Static` of

of(...classes: string[]): SimpleInfoProvider
Parameters
- Rest ...classes: string[]
Returns SimpleInfoProvider
Inherited from InfoProvider.of
- Defined in src/game/game/inspection/InfoProvider.ts:107

`Static` ofComponent

ofComponent(componentSupplier: (() => default<HTMLElement>)): InfoProvider
Parameters
- componentSupplier: (() => default<HTMLElement>)
  - - (): default<HTMLElement>
    - Returns default<HTMLElement>
Returns InfoProvider
Inherited from InfoProvider.ofComponent
- Defined in src/game/game/inspection/InfoProvider.ts:145

`Static` subtitle

subtitle(...translations: (undefined | TranslationGenerator | InfoProvider)[]): SimpleInfoProvider
Parameters
- Rest ...translations: (undefined | TranslationGenerator | InfoProvider)[]
Returns SimpleInfoProvider
Inherited from InfoProvider.subtitle
- Defined in src/game/game/inspection/InfoProvider.ts:119

`Static` text

text(...translations: (undefined | TranslationGenerator | InfoProvider)[]): SimpleInfoProvider
Parameters
- Rest ...translations: (undefined | TranslationGenerator | InfoProvider)[]
Returns SimpleInfoProvider
Inherited from InfoProvider.text
- Defined in src/game/game/inspection/InfoProvider.ts:132

`Static` title

title(...translations: (undefined | TranslationGenerator | InfoProvider)[]): SimpleInfoProvider
Parameters
- Rest ...translations: (undefined | TranslationGenerator | InfoProvider)[]
Returns SimpleInfoProvider
Inherited from InfoProvider.title
- Defined in src/game/game/inspection/InfoProvider.ts:112

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

magic: default

Returns default

Properties

Protected Optional component

Protected Optional context

Readonly event

Static multiTextParagraph

Methods

get

Returns default

getClass

Returns string[]

getDefaultDisplayLevel

Parameters

_context: InfoProviderContext

Returns InfoDisplayLevel | Set<InfoDisplayLevel>

getDisplayLevel

Parameters

context: InfoProviderContext

Returns Set<InfoDisplayLevel>

getIcon

Returns { height: number; path: default<InfoIcon>; width: number; }

height: number

path: default<InfoIcon>

width: number

hasContent

Returns boolean

init

Returns void

Protected initChildTextComponent

Parameters

text: TranslationGenerator

Returns default

initComponent

Parameters

context: InfoProviderContext

component: default<HTMLElement> = ...

partial: boolean = false

data: { lastInfoSleep: number; } = ...

lastInfoSleep: number

Returns { component: default<HTMLElement>; fullInit(): void; }

component: default<HTMLElement>

fullInit:function

Returns void

onStoppingPlay

Returns void

recheckHasContent

Returns default

refresh

Returns default

refreshDisplayLevel

Returns default

remove

Returns default

setComponent

Parameters

componentClass: Class<default<HTMLElement>, any[]>

Returns default

setComponentInitializer

Parameters

initializer: ((componenent: default<HTMLElement>) => any)

Parameters

componenent: default<HTMLElement>

Returns any

Returns default

setDisplayLevel

Parameters

Rest ...displayLevel: (undefined | InfoDisplayLevel)[]

Returns default

setIcon

Parameters

`Protected` `Optional` component

`Protected` `Optional` context

`Readonly` event

`Static` multiTextParagraph

Returns {
height: number;
path: default<InfoIcon>;
width: number;
}

`Protected` initChildTextComponent

data: {
lastInfoSleep: number;
} = ...

Returns {
component: default<HTMLElement>;
fullInit(): void;
}

`Rest` ...displayLevel: (undefined | InfoDisplayLevel)[]

`Optional` icon: string | IIcon

`Rest` ...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]

`Static` create

`Rest` ...translations: TranslationGenerator[]

`Static` description

`Rest` ...translations: (undefined | TranslationGenerator | InfoProvider)[]

`Static` dynamic

`Static` get

`Optional` magic: default | {
magic?: default;
}

`Static` getFireStageTranslation

`Optional` decay: number

`Static` list

`Rest` ...translations: (undefined | TranslationGenerator | InfoProvider)[]