Class InfoProvider`Abstract`

Hierarchy

Host<IInfoProviderEvents>
- InfoProvider
  - SimpleInfoProvider
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - StatsInfoProvider
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - default
  - StatInfo

Implements

IRefreshable

Constructors

constructor

new InfoProvider(): InfoProvider
Returns InfoProvider

Inherited from EventEmitter.Host<IInfoProviderEvents>.constructor

Properties

`Protected` `Optional` component

component?: default<HTMLElement>

`Protected` `Optional` context

context?: InfoProviderContext

`Readonly` event

event: IEventEmitter<InfoProvider, IInfoProviderEvents>

`Readonly` subscribeRefreshOn

subscribeRefreshOn: IRegistrar<InfoProvider> = ...

`Static` multiTextParagraph

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

Methods

appendTo

appendTo(place: default<HTMLElement>): default<HTMLElement>
Initialise this InfoProvider and append it to a component. The InfoProvider will be disposed on removal.
Parameters
- place: default<HTMLElement>
Returns default<HTMLElement>
- Defined in src/game/game/inspection/InfoProvider.ts:466

`Abstract` get

get(context: InfoProviderContext): ArrayOr<TranslationGenerator | InfoProvider>
Parameters
- context: InfoProviderContext
Returns ArrayOr<TranslationGenerator | InfoProvider>
- Defined in src/game/game/inspection/InfoProvider.ts:193

`Abstract` getClass

getClass(context: InfoProviderContext): string[]
Parameters
- context: InfoProviderContext
Returns string[]
- Defined in src/game/game/inspection/InfoProvider.ts:196

getDefaultDisplayLevel

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

getDisplayLevel

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

getIcon

getIcon(): undefined | string | IIcon
Returns undefined | string | IIcon
- Defined in src/game/game/inspection/InfoProvider.ts:240

hasContent

hasContent(_context: InfoProviderContext): boolean
Parameters
- _context: InfoProviderContext
Returns boolean
- Defined in src/game/game/inspection/InfoProvider.ts:249

init

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

`Protected` initChildTextComponent

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

initComponent

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

onStoppingPlay

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

recheckHasContent

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

Returns InfoProvider
- Defined in src/game/game/inspection/InfoProvider.ts:269

refresh

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

Returns InfoProvider
Implementation of IRefreshable.refresh
- Defined in src/game/game/inspection/InfoProvider.ts:261

refreshDisplayLevel

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

Returns InfoProvider
- Defined in src/game/game/inspection/InfoProvider.ts:277

remove

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

Returns InfoProvider
- Defined in src/game/game/inspection/InfoProvider.ts:285

setComponent

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

setComponentInitializer

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

setDisplayLevel

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

setIcon

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

setShouldDisplayWhenEmpty

setShouldDisplayWhenEmpty(shouldDisplayWhenEmpty?: boolean): InfoProvider
Parameters
- shouldDisplayWhenEmpty: boolean = true
Returns InfoProvider
- Defined in src/game/game/inspection/InfoProvider.ts:301

`Protected` shouldDisplayWhenEmpty

shouldDisplayWhenEmpty(): boolean
Returns boolean
- Defined in src/game/game/inspection/InfoProvider.ts:297

`Static` create

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

`Static` description

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

`Static` dynamic

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

`Static` header

header(...classes: string[]): SimpleInfoProvider
Parameters
- Rest ...classes: string[]
Returns SimpleInfoProvider
- Defined in src/game/game/inspection/InfoProvider.ts:120

`Static` list

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

`Static` of

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

`Static` ofComponent

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

`Static` subtitle

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

`Static` text

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

`Static` textlist

textlist(...translations: (undefined | TranslationGenerator | InfoProvider)[]): SimpleInfoProvider
Parameters
- Rest ...translations: (undefined | TranslationGenerator | InfoProvider)[]
Returns SimpleInfoProvider
- Defined in src/game/game/inspection/InfoProvider.ts:159

`Static` title

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

Class InfoProviderAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns InfoProvider

Properties

Protected Optional component

Protected Optional context

Readonly event

Readonly subscribeRefreshOn

Static multiTextParagraph

Methods

appendTo

Parameters

place: default<HTMLElement>

Returns default<HTMLElement>

Abstract get

Parameters

context: InfoProviderContext

Returns ArrayOr<TranslationGenerator | InfoProvider>

Abstract getClass

Parameters

context: InfoProviderContext

Returns string[]

getDefaultDisplayLevel

Parameters

_context: InfoProviderContext

Returns InfoDisplayLevel | Set<InfoDisplayLevel>

getDisplayLevel

Parameters

context: InfoProviderContext

Returns Set<InfoDisplayLevel>

getIcon

Returns undefined | string | IIcon

hasContent

Parameters

_context: InfoProviderContext

Returns boolean

init

Returns void

Protected initChildTextComponent

Parameters

text: TranslationGenerator

Returns default

initComponent

Parameters

context: InfoProviderContext

component: default<HTMLElement> = ...

partial: boolean = false

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

component: default<HTMLElement>

fullInit:function

Returns void

onStoppingPlay

Returns void

recheckHasContent

Returns InfoProvider

refresh

Returns InfoProvider

refreshDisplayLevel

Returns InfoProvider

remove

Returns InfoProvider

setComponent

Parameters

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

Returns InfoProvider

setComponentInitializer

Parameters

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

Parameters

componenent: default<HTMLElement>

Returns any

Returns InfoProvider

setDisplayLevel

Class InfoProvider`Abstract`

`Protected` `Optional` component

`Protected` `Optional` context

`Readonly` event

`Readonly` subscribeRefreshOn

`Static` multiTextParagraph

`Abstract` get

`Abstract` getClass

`Protected` initChildTextComponent

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

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

`Optional` icon: string | IIcon

`Protected` shouldDisplayWhenEmpty

`Static` create

`Rest` ...translations: TranslationGenerator[]

`Static` description

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

`Static` dynamic

`Static` header

`Rest` ...classes: string[]

`Static` list

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

`Static` of

`Rest` ...classes: string[]

`Static` ofComponent

`Static` subtitle

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

`Static` text

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

`Static` textlist

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

`Static` title

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