Class default

Hierarchy

InfoProvider
- default

Properties

`Protected` `Optional` component

component?: default<HTMLElement>

`Protected` `Optional` context

context?: InfoProviderContext

`Readonly` event

event: IEventEmitter<default, IInfoProviderEvents>

`Readonly` subscribeRefreshOn

subscribeRefreshOn: IRegistrar<default> = ...

`Static` multiTextParagraph

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

Methods

add

addClasses

addClasses(...classes: string[]): default
Parameters
- Rest ...classes: string[]
Returns default
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:67

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>
Inherited from InfoProvider.appendTo
- Defined in src/game/game/inspection/InfoProvider.ts:466

get

get(): (default | InfoProvider)[]
Returns (default | InfoProvider)[]
Overrides InfoProvider.get
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:102

getClass

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

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:198

getDisplayLevel

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

getIcon

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

hasContent

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

init

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

`Protected` initChildTextComponent

initChildTextComponent(text: TranslationGenerator): default
Parameters
- text: TranslationGenerator
Returns default
Overrides InfoProvider.initChildTextComponent
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:157

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
Inherited from InfoProvider.initComponent
- Defined in src/game/game/inspection/InfoProvider.ts:306

onStoppingPlay

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

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:269

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:261

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:277

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:285

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:228

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:234

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:202

setDisplayMode

setDisplayMode(mode: "label: value" | "label (value)" | "value label" | "value (label)" | "label value" | "label - value" | "valuelabel"): default
Parameters
- mode: "label: value" | "label (value)" | "value label" | "value (label)" | "label value" | "label - value" | "valuelabel"
Returns default
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:161
setDisplayMode(mode: "label: value" | "label (value)" | "value label" | "value (label)" | "label value" | "label - value" | "valuelabel"): default
Parameters
- mode: "label: value" | "label (value)" | "value label" | "value (label)" | "label value" | "label - value" | "valuelabel"
Returns default
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:162
setDisplayMode(mode: "label: value" | "label (value)" | "value label" | "value (label)" | "label value" | "label - value" | "valuelabel", contentDisplayLevel?: InfoDisplayLevel): default
Parameters
- mode: "label: value" | "label (value)" | "value label" | "value (label)" | "label value" | "label - value" | "valuelabel"
- Optional contentDisplayLevel: InfoDisplayLevel
Returns default
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:163

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:244

setInline

setInline(): default
Returns default
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:170

setLabelDisplayLevel

setLabelDisplayLevel(displayLevel?: InfoDisplayLevel): default
Parameters
- Optional displayLevel: InfoDisplayLevel
Returns default
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:180

setLabelRow

setLabelRow(): default
Returns default
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:175

setShouldDisplayWhenEmpty

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

`Protected` shouldDisplayWhenEmpty

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

`Static` create

create(...translations: TranslationGenerator[]): SimpleInfoProvider
Parameters
- Rest ...translations: TranslationGenerator[]
Returns SimpleInfoProvider
Inherited from InfoProvider.create
- 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
Inherited from InfoProvider.description
- 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
Inherited from InfoProvider.dynamic
- Defined in src/game/game/inspection/InfoProvider.ts:102

`Static` header

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

`Static` label

label(label: default | InfoProvider | GetterOfOr<default>): {
add(...values: GetterOfOr<undefined | default | default | InfoProvider>[]): default;
}
Parameters
- label: default | InfoProvider | GetterOfOr<default>
Returns {
add(...values: GetterOfOr<undefined | default | default | InfoProvider>[]): default;
}
- add:function
  - add(...values: GetterOfOr<undefined | default | default | InfoProvider>[]): default
  - Parameters
    - Rest ...values: GetterOfOr<undefined | default | default | InfoProvider>[]
    Returns default
    - Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:34
- Defined in src/game/game/inspection/infoProviders/LabelledValue.ts:34

`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:151

`Static` of

of(...classes: string[]): SimpleInfoProvider
Parameters
- Rest ...classes: string[]
Returns SimpleInfoProvider
Inherited from InfoProvider.of
- 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
Inherited from InfoProvider.ofComponent
- 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
Inherited from InfoProvider.subtitle
- 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
Inherited from InfoProvider.text
- 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
Inherited from InfoProvider.textlist
- 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
Inherited from InfoProvider.title
- Defined in src/game/game/inspection/InfoProvider.ts:125

Class default

Hierarchy

Index

Properties

Methods

Properties

Protected Optional component

Protected Optional context

Readonly event

Readonly subscribeRefreshOn

Static multiTextParagraph

Methods

add

Parameters

Returns default

addClasses

Parameters

Rest ...classes: string[]

Returns default

appendTo

Parameters

place: default<HTMLElement>

Returns default<HTMLElement>

get

Returns (default | InfoProvider)[]

getClass

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 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)[]

`Protected` `Optional` component

`Protected` `Optional` context

`Readonly` event

`Readonly` subscribeRefreshOn

`Static` multiTextParagraph

`Rest` ...classes: string[]

`Protected` initChildTextComponent

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

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

`Optional` contentDisplayLevel: InfoDisplayLevel

`Optional` icon: string | IIcon

`Optional` displayLevel: InfoDisplayLevel

`Protected` shouldDisplayWhenEmpty

`Static` create

`Rest` ...translations: TranslationGenerator[]

`Static` description

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

`Static` dynamic

`Static` header

`Rest` ...classes: string[]

`Static` label

Returns {
add(...values: GetterOfOr<undefined | default | default | InfoProvider>[]): default;
}

`Rest` ...values: GetterOfOr<undefined | default | default | InfoProvider>[]

`Static` list

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

`Static` of

`Rest` ...classes: string[]

`Static` ofComponent