Class default

Hierarchy

StatInfo
- default

Constructors

constructor

new default(stat: Stat, human: default<unknown, number, NPC | Player>): default
Parameters
- stat: Stat
- human: default<unknown, number, NPC | Player>
Returns default
Inherited from StatInfo.constructor
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:47

Properties

`Readonly` civilizationScore

civilizationScore: Observer<number> = ...

`Protected` `Optional` component

component?: default<HTMLElement>

`Protected` `Optional` context

context?: InfoProviderContext

`Readonly` event

event: IEventEmitter<default, IInfoProviderEvents>

`Protected` `Readonly` humanRef

humanRef: WeakRef<default<unknown, number, NPC | Player>>

`Readonly` score

score: Observer<number> = ...

`Readonly` stat

stat: Stat

`Readonly` subscribeRefreshOn

subscribeRefreshOn: IRegistrar<default> = ...

`Readonly` ticks

ticks: Observer<number> = ...

`Readonly` time

time: Observer<default> = ...

`Readonly` totalCivilizationScore

totalCivilizationScore: Observer<number> = ...

`Readonly` turns

turns: Observer<number> = ...

`Static` multiTextParagraph

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

Accessors

`Protected` human

get human(): undefined | default<unknown, number, NPC | Player>
Returns undefined | default<unknown, number, NPC | Player>
Inherited from StatInfo.human
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:43

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

get

get(): InfoProvider[]
Returns InfoProvider[]
Overrides StatInfo.get
- Defined in src/game/game/inspection/infoProviders/stat/GenericInfo.ts:37

getBorderColorPreference

getBorderColorPreference(): undefined | string | ((entity: undefined | default<unknown, number, EntityReferenceTypes, unknown>, stat: IStat) => string)
Returns undefined | string | ((entity: undefined | default<unknown, number, EntityReferenceTypes, unknown>, stat: IStat) => string)
Inherited from StatInfo.getBorderColorPreference
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:68

getClass

getClass(): string[]
Returns string[]
Overrides StatInfo.getClass
- Defined in src/game/game/inspection/infoProviders/stat/GenericInfo.ts:33

`Optional` getCoreStat

getCoreStat(): Stat
Returns Stat
Inherited from StatInfo.getCoreStat
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:72

getDefaultDisplayLevel

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

getDescription

getDescription(): undefined | default | InfoProvider
Returns undefined | default | InfoProvider
Inherited from StatInfo.getDescription
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:60

getDisplayLevel

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

getIcon

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

getMaxLabel

getMaxLabel(): default
Returns default
Inherited from StatInfo.getMaxLabel
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:74

getTitle

getTitle(): default | SimpleInfoProvider
Returns default | SimpleInfoProvider
Inherited from StatInfo.getTitle
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:56

hasContent

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

init

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

`Protected` initChildTextComponent

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

onStoppingPlay

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

setShouldDisplayWhenEmpty

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

`Protected` shouldDisplayWhenEmpty

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

`Static` create

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

`Static` getDescription

getDescription(stat: Stat): undefined | default | InfoProvider
Parameters
- stat: Stat
Returns undefined | default | InfoProvider
Inherited from StatInfo.getDescription
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:35

`Static` getTitle

getTitle(stat: Stat): default | SimpleInfoProvider
Parameters
- stat: Stat
Returns default | SimpleInfoProvider
Inherited from StatInfo.getTitle
- Defined in src/game/game/inspection/infoProviders/stat/StatInfo.ts:30

`Static` header

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

`Static` of

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

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

stat: Stat

human: default<unknown, number, NPC | Player>

Returns default

Properties

Readonly civilizationScore

Protected Optional component

Protected Optional context

Readonly event

Protected Readonly humanRef

Readonly score

Readonly stat

Readonly subscribeRefreshOn

Readonly ticks

Readonly time

Readonly totalCivilizationScore

Readonly turns

Static multiTextParagraph

Accessors

Protected human

Returns undefined | default<unknown, number, NPC | Player>

Methods

appendTo

Parameters

place: default<HTMLElement>

Returns default<HTMLElement>

get

Returns InfoProvider[]

getBorderColorPreference

Returns undefined | string | ((entity: undefined | default<unknown, number, EntityReferenceTypes, unknown>, stat: IStat) => string)

getClass

Returns string[]

Optional getCoreStat

Returns Stat

getDefaultDisplayLevel

Parameters

_context: InfoProviderContext

Returns InfoDisplayLevel | Set<InfoDisplayLevel>

getDescription

Returns undefined | default | InfoProvider

getDisplayLevel

Parameters

context: InfoProviderContext

Returns Set<InfoDisplayLevel>

getIcon

Returns undefined | string | IIcon

getMaxLabel

Returns default

getTitle

Returns default | SimpleInfoProvider

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

`Readonly` civilizationScore

`Protected` `Optional` component

`Protected` `Optional` context

`Readonly` event

`Protected` `Readonly` humanRef

`Readonly` score

`Readonly` stat

`Readonly` subscribeRefreshOn

`Readonly` ticks

`Readonly` time

`Readonly` totalCivilizationScore

`Readonly` turns

`Static` multiTextParagraph

`Protected` human

`Optional` getCoreStat

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

`Static` getTitle

`Static` header

`Rest` ...classes: string[]

`Static` list

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

`Static` of

`Rest` ...classes: string[]