Class default

Hierarchy

default<default>
- default

Constructors

constructor

new default(value: DoodadType): default
Parameters
- value: DoodadType
Returns default
Inherited from default.constructor
- Defined in src/game/game/inspection/infoProviders/Uses.ts:64
new default(value: default): default
Parameters
- value: default
Returns default
Inherited from default.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?: Readonly<IDoodadDescription>

`Protected` `Readonly` entityType

entityType: Doodad

`Readonly` event

event: IEventEmitter<default, IInfoProviderEvents>

`Readonly` subscribeRefreshOn

subscribeRefreshOn: IRegistrar<default> = ...

`Protected` `Readonly` type

type: DoodadType

`Protected` `Optional` `Readonly` value

value?: default

`Static` multiTextParagraph

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

Methods

addDetails

addDetails(...details: symbol[]): default
Parameters
- Rest ...details: symbol[]
Returns default
Inherited from default.addDetails
- 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 default.appendTo
- Defined in src/game/game/inspection/InfoProvider.ts:466

get

get(context: InfoProviderContext): ArrayOr<TranslationGenerator | InfoProvider>
Parameters
- context: InfoProviderContext
Returns ArrayOr<TranslationGenerator | InfoProvider>
Inherited from default.get
- Defined in src/game/game/inspection/infoProviders/Uses.ts:103

getClass

getClass(): string[]
Returns string[]
Inherited from default.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 default.getDefaultDisplayLevel
- Defined in src/game/game/inspection/InfoProvider.ts:198

`Protected` getDescription

getDescription(type: DoodadType): undefined | IDoodadDescription
Parameters
- type: DoodadType
Returns undefined | IDoodadDescription
Overrides default.getDescription
- Defined in src/game/game/inspection/infoProviders/doodad/DoodadUses.ts:28

getDisplayLevel

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

`Protected` getEntityType

getEntityType(): Doodad
Returns Doodad
Overrides default.getEntityType
- Defined in src/game/game/inspection/infoProviders/doodad/DoodadUses.ts:24

getIcon

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

`Protected` getUse

getUse(description: Readonly<IDoodadDescription>, action: ActionType): default
Parameters
- description: Readonly<IDoodadDescription>
- action: ActionType
Returns default
Inherited from default.getUse
- 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
Inherited from default.getUseDisplayLevel
- Defined in src/game/game/inspection/infoProviders/Uses.ts:251

`Protected` getUseInfoHandlers

getUseInfoHandlers(): default<IUseInfoBase<default, StartFire | Ignite | Equip>, StartFire | Ignite | Equip, {}, default>[]
Returns default<IUseInfoBase<default, StartFire | Ignite | Equip>, StartFire | Ignite | Equip, {}, default>[]
Overrides default.getUseInfoHandlers
- Defined in src/game/game/inspection/infoProviders/doodad/DoodadUses.ts:38

`Protected` getUses

getUses(description: IDoodadDescription): ActionType[]
Parameters
- description: IDoodadDescription
Returns ActionType[]
Overrides default.getUses
- Defined in src/game/game/inspection/infoProviders/doodad/DoodadUses.ts:32

hasContent

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

init

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

`Protected` initChildTextComponent

initChildTextComponent(text: TranslationGenerator): default
Parameters
- text: TranslationGenerator
Returns default
Inherited from default.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 default.initComponent
- Defined in src/game/game/inspection/InfoProvider.ts:306

onStoppingPlay

onStoppingPlay(): void
Returns void
Inherited from default.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 default.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 default.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 default.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 default.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 default.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 default.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 default.setDisplayLevel
- Defined in src/game/game/inspection/InfoProvider.ts:202

setIcon

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

setLabel

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

setShouldDisplayWhenEmpty

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

`Protected` shouldDisplayWhenEmpty

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

`Static` create

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

`Static` header

header(...classes: string[]): SimpleInfoProvider
Parameters
- Rest ...classes: string[]
Returns SimpleInfoProvider
Inherited from default.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 default.list
- Defined in src/game/game/inspection/InfoProvider.ts:151

`Static` of

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

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

value: DoodadType

Returns default

Parameters

value: default

Returns default

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

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 getDescription

Parameters

type: DoodadType

Returns undefined | IDoodadDescription

getDisplayLevel

Parameters

context: InfoProviderContext

Returns Set<InfoDisplayLevel>

Protected getEntityType

Returns Doodad

getIcon

Returns undefined | string | IIcon

Protected getUse

Parameters

description: Readonly<IDoodadDescription>

action: ActionType

Returns default

Protected getUseDisplayLevel

Parameters

action: ActionType

context: InfoProviderContext

Returns InfoDisplayLevel

Protected getUseInfoHandlers

Returns default<IUseInfoBase<default, StartFire | Ignite | Equip>, StartFire | Ignite | Equip, {}, default>[]

Protected getUses

Parameters

description: IDoodadDescription

Returns ActionType[]

hasContent

Parameters

_context: InfoProviderContext

Returns boolean

init

Returns void

Protected initChildTextComponent

Parameters

text: TranslationGenerator

`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` getDescription

`Protected` getEntityType

`Protected` getUse

`Protected` getUseDisplayLevel

`Protected` getUseInfoHandlers

`Protected` 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

`Static` header

`Rest` ...classes: string[]