Class default<T>`Abstract`

Type Parameters

T extends IDescribed

Hierarchy

InfoProvider
- default
  - default
  - default

Constructors

constructor

new default<T>(value: T["type"]): default<T>
Type Parameters
- T extends IDescribed
Parameters
- value: T["type"]
Returns default<T>
Overrides InfoProvider.constructor
- Defined in src/game/game/inspection/infoProviders/Uses.ts:64
new default<T>(value: T): default<T>
Type Parameters
- T extends IDescribed
Parameters
- value: T
Returns default<T>
Overrides InfoProvider.constructor
- Defined in src/game/game/inspection/infoProviders/Uses.ts:65

Properties

`Protected` `Optional` component

component?: default<HTMLElement>

`Protected` `Optional` context

context?: InfoProviderContext

`Protected` `Optional` `Readonly` description

description?: Exclude<T["description"], undefined>

`Protected` `Readonly` entityType

entityType: T["entityType"]

`Readonly` event

event: IEventEmitter<default<T>, IInfoProviderEvents>

`Readonly` subscribeRefreshOn

subscribeRefreshOn: IRegistrar<default<T>> = ...

`Protected` `Readonly` type

type: T["type"]

`Protected` `Optional` `Readonly` value

value?: T

`Static` multiTextParagraph

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

Methods

addDetails

addDetails(...details: symbol[]): default<T>
Parameters
- Rest ...details: symbol[]
Returns default<T>
- Defined in src/game/game/inspection/infoProviders/Uses.ts:96

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(context: InfoProviderContext): ArrayOr<TranslationGenerator | InfoProvider>
Parameters
- context: InfoProviderContext
Returns ArrayOr<TranslationGenerator | InfoProvider>
Overrides InfoProvider.get
- Defined in src/game/game/inspection/infoProviders/Uses.ts:103

getClass

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

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

`Protected` `Abstract` getDescription

getDescription(type: T["type"]): undefined | DescribedDescription<T>
Parameters
- type: T["type"]
Returns undefined | DescribedDescription<T>
- Defined in src/game/game/inspection/infoProviders/Uses.ts:62

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

`Protected` `Abstract` getEntityType

getEntityType(): T["entityType"]
Returns T["entityType"]
- Defined in src/game/game/inspection/infoProviders/Uses.ts:61

getIcon

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

`Protected` getUse

getUse(description: DescribedDescription<T>, action: ActionType): default
Parameters
- description: DescribedDescription<T>
- action: ActionType
Returns default
- Defined in src/game/game/inspection/infoProviders/Uses.ts:293

`Protected` getUseDisplayLevel

getUseDisplayLevel(action: ActionType, context: InfoProviderContext): InfoDisplayLevel
Parameters
- action: ActionType
- context: InfoProviderContext
Returns InfoDisplayLevel
- Defined in src/game/game/inspection/infoProviders/Uses.ts:251

`Protected` `Abstract` getUseInfoHandlers

getUseInfoHandlers(description: DescribedDescription<T>): default<any, any, any, T>[]
Parameters
- description: DescribedDescription<T>
Returns default<any, any, any, T>[]
- Defined in src/game/game/inspection/infoProviders/Uses.ts:83

`Protected` `Abstract` getUses

getUses(description: DescribedDescription<T>): ActionType[]
Parameters
- description: DescribedDescription<T>
Returns ActionType[]
- Defined in src/game/game/inspection/infoProviders/Uses.ts:82

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
Inherited from InfoProvider.initChildTextComponent
- 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
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<T>
Call when this info provider should recheck whether it has contents.

Returns default<T>
Inherited from InfoProvider.recheckHasContent
- Defined in src/game/game/inspection/InfoProvider.ts:269

refresh

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

Returns default<T>
Inherited from InfoProvider.refresh
- Defined in src/game/game/inspection/InfoProvider.ts:261

refreshDisplayLevel

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

Returns default<T>
Inherited from InfoProvider.refreshDisplayLevel
- Defined in src/game/game/inspection/InfoProvider.ts:277

remove

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

Returns default<T>
Inherited from InfoProvider.remove
- Defined in src/game/game/inspection/InfoProvider.ts:285

setComponent

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

setComponentInitializer

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

setDisplayLevel

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

setIcon

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

setLabel

setLabel(label: default | default): default<T>
Parameters
- label: default | default
Returns default<T>
- Defined in src/game/game/inspection/infoProviders/Uses.ts:89

setShouldDisplayWhenEmpty

setShouldDisplayWhenEmpty(shouldDisplayWhenEmpty?: boolean): default<T>
Parameters
- shouldDisplayWhenEmpty: boolean = true
Returns default<T>
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` 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<T>Abstract

Type Parameters

T extends IDescribed

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends IDescribed

Parameters

value: T["type"]

Returns default<T>

Type Parameters

T extends IDescribed

Parameters

value: T

Returns default<T>

Properties

Protected Optional component

Protected Optional context

Protected Optional Readonly description

Protected Readonly entityType

Readonly event

Readonly subscribeRefreshOn

Protected Readonly type

Protected Optional Readonly value

Static multiTextParagraph

Methods

addDetails

Parameters

Rest ...details: symbol[]

Returns default<T>

appendTo

Parameters

place: default<HTMLElement>

Returns default<HTMLElement>

get

Parameters

context: InfoProviderContext

Returns ArrayOr<TranslationGenerator | InfoProvider>

getClass

Returns string[]

getDefaultDisplayLevel

Parameters

_context: InfoProviderContext

Returns InfoDisplayLevel | Set<InfoDisplayLevel>

Protected Abstract getDescription

Parameters

type: T["type"]

Returns undefined | DescribedDescription<T>

getDisplayLevel

Parameters

context: InfoProviderContext

Returns Set<InfoDisplayLevel>

Protected Abstract getEntityType

Returns T["entityType"]

getIcon

Returns undefined | string | IIcon

Protected getUse

Parameters

description: DescribedDescription<T>

action: ActionType

Returns default

Protected getUseDisplayLevel

Parameters

action: ActionType

context: InfoProviderContext

Returns InfoDisplayLevel

Protected Abstract getUseInfoHandlers

Parameters

description: DescribedDescription<T>

Returns default<any, any, any, T>[]

Protected Abstract getUses

Parameters

description: DescribedDescription<T>

Returns ActionType[]

hasContent

Class default<T>`Abstract`

`Protected` `Optional` component

`Protected` `Optional` context

`Protected` `Optional` `Readonly` description

`Protected` `Readonly` entityType

`Readonly` event

`Readonly` subscribeRefreshOn

`Protected` `Readonly` type

`Protected` `Optional` `Readonly` value

`Static` multiTextParagraph

`Rest` ...details: symbol[]

`Protected` `Abstract` getDescription

`Protected` `Abstract` getEntityType

`Protected` getUse

`Protected` getUseDisplayLevel

`Protected` `Abstract` getUseInfoHandlers

`Protected` `Abstract` getUses

`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