Class default

Hierarchy

default<default>
- default

Constructors

constructor

new default(value: ItemType): default
Parameters
- value: ItemType
Returns default
Inherited from default.constructor
- Defined in src/game/game/inspection/infoProviders/Uses.ts:57
new default(value: default): default
Parameters
- value: default
Returns default
Inherited from default.constructor
- Defined in src/game/game/inspection/infoProviders/Uses.ts:58

Properties

`Protected` `Optional` component

component?: default<HTMLElement>

`Protected` `Optional` context

context?: InfoProviderContext

`Protected` `Optional` `Readonly` description

description?: IItemDescription

`Protected` `Readonly` entityType

entityType: Item

`Readonly` event

event: IEventEmitter<default, IInfoProviderEvents> = ...

`Protected` `Readonly` type

type: ItemType

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

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

getClass

getClass(): string[]
Returns string[]
Inherited from default.getClass
- Defined in src/game/game/inspection/infoProviders/Uses.ts:78

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

`Protected` getDescription

getDescription(type: ItemType): IItemDescription
Parameters
- type: ItemType
Returns IItemDescription
Overrides default.getDescription
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:47

getDisplayLevel

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

`Protected` getEntityType

getEntityType(): Item
Returns Item
Overrides default.getEntityType
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:43

getIcon

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

`Protected` getUse

getUse(description: IItemDescription, action: ActionType): default
Parameters
- description: IItemDescription
- action: ActionType
Returns default
Overrides default.getUse
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:89

`Protected` getUseDisplayLevel

getUseDisplayLevel(action: ActionType, context: InfoProviderContext): InfoDisplayLevel
Parameters
- action: ActionType
- context: InfoProviderContext
Returns InfoDisplayLevel
Overrides default.getUseDisplayLevel
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:63

`Protected` getUseInfoHandlers

getUseInfoHandlers(): (default<{
    action: Build;
    civilizationScore: undefined | number;
    description: IItemDescription;
    details: Set<symbol>;
    doodadContainer: undefined | IDoodadDescription;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Build>;
    value?: default;
}, Build, {
    getWeightCapacity: ((...args: []) => undefined | default);
} & {
    formatInsulation: ((...args: [insulation: number, type?: TempType]) => default);
} & {
    getInsulationOfType: ((...args: [type: TempType]) => undefined | default);
} & {
    getInsulation: ((...args: []) => (undefined | default)[]);
} & {
    getPreservationChance: ((...args: []) => undefined | default);
} & {
    getCivilizationScore: ((...args: []) => undefined | default);
} & {
    getMagicalBuildTypes: ((...args: []) => Set<MagicalPropertyType>);
} & {
    getMagicEffect: ((...args: [magic: MagicalPropertyEntry]) => default);
} & {
    getDoodadSkill: ((...args: []) => default[]);
}, default> | default<{
    action: Eat | DrinkItem | Heal | Cure | HealOther;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    itemQuality: undefined | Quality;
    magicalBonus: number;
    onConsume: [Stat, number][];
    quality: Quality;
    qualityBonus: number;
    skill: undefined | SkillType;
    skillBonus: number;
    type: ItemType;
    union: IUseInfoBase<default, Eat | DrinkItem | Heal | Cure | HealOther>;
    value?: default;
}, Eat | DrinkItem | Heal | Cure | HealOther, {
    generateUseConsumeTooltip: ((...args: []) => ((tooltip: default, stat: Stat, base: number) => default));
}, default> | default<{
    action: Craft;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Craft>;
    value?: default;
}, Craft, {}, default> | default<{
    action: Disassemble;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    requiredItems: (ItemType | ItemTypeGroup)[];
    type: ItemType;
    union: IUseInfoBase<default, Disassemble>;
    value?: default;
}, Disassemble, {
    getRequiredItems: ((...args: []) => default[]);
}, default> | default<{
    action: Dismantle;
    description: IItemDescription;
    details: Set<symbol>;
    dismantle: IDismantleDescription;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Dismantle>;
    value?: default;
}, Dismantle, {}, default> | default<{
    action: Equip;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    equip: EquipType;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Equip>;
    value?: default;
}, Equip, {
    getMagicalEquipTypes: ((...args: []) => Set<MagicalPropertyType>);
} & {
    getMagicalPropertyLabels: ((...args: []) => Map<MagicalPropertyType, default>);
} & {
    isMagicalPropertyPercentage: ((...args: [property: MagicalPropertyType]) => boolean);
} & {
    isMagicalPropertyPercentagePremultiplied: ((...args: [property: MagicalPropertyType]) => boolean);
} & {
    getAttack: ((...args: []) => undefined | default);
} & {
    getDefense: ((...args: []) => (default | default)[]);
} & {
    formatInsulation: ((...args: [insulation?: number, type?: TempType]) => default);
} & {
    getInsulationOfType: ((...args: [type: TempType]) => undefined | default);
} & {
    getInsulation: ((...args: []) => (undefined | default)[]);
} & {
    getMagicEffect: ((...args: [magic: MagicalPropertyEntry]) => default);
} & {
    getMagic: ((...args: []) => default[]);
}, default> | default<{
    action: Offer;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Offer>;
    value?: default;
}, Offer, {}, default> | default<{
    action: Cast | Fire;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    ranged: IRanged;
    type: ItemType;
    union: IUseInfoBase<default, Cast | Fire>;
    value?: default;
}, Cast | Fire, {}, default> | default<{
    action: SetDown;
    civilizationScore: undefined | number;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    growingSpeed: undefined | number;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, SetDown>;
    value?: default;
}, SetDown, {
    getCivilizationScore: ((...args: []) => undefined | default);
} & {
    getGrowingSpeed: ((...args: []) => undefined | default);
}, default> | default<{
    action: Shoot;
    attack: number;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Shoot>;
    value?: default;
}, Shoot, {}, default> | default<{
    action: StokeFire;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    stoke: number;
    type: ItemType;
    union: IUseInfoBase<default, StokeFire>;
    value?: default;
}, StokeFire, {}, default> | default<{
    action: Equip;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    telescopy: number;
    type: ItemType;
    union: IUseInfoBase<default, Equip>;
    value?: default;
}, Equip, {}, default> | default<IUseInfoBase<default, Throw>, Throw, {}, default> | default<{
    action: Build;
    damage: number;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Build>;
    value?: default;
}, Build, {}, default> | default<IUseInfoBase<default, StartFire | Ignite | Equip>, StartFire | Ignite | Equip, {}, default>)[]
Returns (default<{
    action: Build;
    civilizationScore: undefined | number;
    description: IItemDescription;
    details: Set<symbol>;
    doodadContainer: undefined | IDoodadDescription;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Build>;
    value?: default;
}, Build, {
    getWeightCapacity: ((...args: []) => undefined | default);
} & {
    formatInsulation: ((...args: [insulation: number, type?: TempType]) => default);
} & {
    getInsulationOfType: ((...args: [type: TempType]) => undefined | default);
} & {
    getInsulation: ((...args: []) => (undefined | default)[]);
} & {
    getPreservationChance: ((...args: []) => undefined | default);
} & {
    getCivilizationScore: ((...args: []) => undefined | default);
} & {
    getMagicalBuildTypes: ((...args: []) => Set<MagicalPropertyType>);
} & {
    getMagicEffect: ((...args: [magic: MagicalPropertyEntry]) => default);
} & {
    getDoodadSkill: ((...args: []) => default[]);
}, default> | default<{
    action: Eat | DrinkItem | Heal | Cure | HealOther;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    itemQuality: undefined | Quality;
    magicalBonus: number;
    onConsume: [Stat, number][];
    quality: Quality;
    qualityBonus: number;
    skill: undefined | SkillType;
    skillBonus: number;
    type: ItemType;
    union: IUseInfoBase<default, Eat | DrinkItem | Heal | Cure | HealOther>;
    value?: default;
}, Eat | DrinkItem | Heal | Cure | HealOther, {
    generateUseConsumeTooltip: ((...args: []) => ((tooltip: default, stat: Stat, base: number) => default));
}, default> | default<{
    action: Craft;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Craft>;
    value?: default;
}, Craft, {}, default> | default<{
    action: Disassemble;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    requiredItems: (ItemType | ItemTypeGroup)[];
    type: ItemType;
    union: IUseInfoBase<default, Disassemble>;
    value?: default;
}, Disassemble, {
    getRequiredItems: ((...args: []) => default[]);
}, default> | default<{
    action: Dismantle;
    description: IItemDescription;
    details: Set<symbol>;
    dismantle: IDismantleDescription;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Dismantle>;
    value?: default;
}, Dismantle, {}, default> | default<{
    action: Equip;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    equip: EquipType;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Equip>;
    value?: default;
}, Equip, {
    getMagicalEquipTypes: ((...args: []) => Set<MagicalPropertyType>);
} & {
    getMagicalPropertyLabels: ((...args: []) => Map<MagicalPropertyType, default>);
} & {
    isMagicalPropertyPercentage: ((...args: [property: MagicalPropertyType]) => boolean);
} & {
    isMagicalPropertyPercentagePremultiplied: ((...args: [property: MagicalPropertyType]) => boolean);
} & {
    getAttack: ((...args: []) => undefined | default);
} & {
    getDefense: ((...args: []) => (default | default)[]);
} & {
    formatInsulation: ((...args: [insulation?: number, type?: TempType]) => default);
} & {
    getInsulationOfType: ((...args: [type: TempType]) => undefined | default);
} & {
    getInsulation: ((...args: []) => (undefined | default)[]);
} & {
    getMagicEffect: ((...args: [magic: MagicalPropertyEntry]) => default);
} & {
    getMagic: ((...args: []) => default[]);
}, default> | default<{
    action: Offer;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Offer>;
    value?: default;
}, Offer, {}, default> | default<{
    action: Cast | Fire;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    ranged: IRanged;
    type: ItemType;
    union: IUseInfoBase<default, Cast | Fire>;
    value?: default;
}, Cast | Fire, {}, default> | default<{
    action: SetDown;
    civilizationScore: undefined | number;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    growingSpeed: undefined | number;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, SetDown>;
    value?: default;
}, SetDown, {
    getCivilizationScore: ((...args: []) => undefined | default);
} & {
    getGrowingSpeed: ((...args: []) => undefined | default);
}, default> | default<{
    action: Shoot;
    attack: number;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Shoot>;
    value?: default;
}, Shoot, {}, default> | default<{
    action: StokeFire;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    stoke: number;
    type: ItemType;
    union: IUseInfoBase<default, StokeFire>;
    value?: default;
}, StokeFire, {}, default> | default<{
    action: Equip;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    telescopy: number;
    type: ItemType;
    union: IUseInfoBase<default, Equip>;
    value?: default;
}, Equip, {}, default> | default<IUseInfoBase<default, Throw>, Throw, {}, default> | default<{
    action: Build;
    damage: number;
    description: IItemDescription;
    details: Set<symbol>;
    entityType: Item;
    quality: Quality;
    type: ItemType;
    union: IUseInfoBase<default, Build>;
    value?: default;
}, Build, {}, default> | default<IUseInfoBase<default, StartFire | Ignite | Equip>, StartFire | Ignite | Equip, {}, default>)[]
Overrides default.getUseInfoHandlers
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:69

`Protected` getUses

getUses(description: IItemDescription): ActionType[]
Parameters
- description: IItemDescription
Returns ActionType[]
Overrides default.getUses
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:51

hasContent

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

init

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

`Protected` initChildTextComponent

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

initComponent

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

onStoppingPlay

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

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

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

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

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

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

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

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

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

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

setSynchronous

setSynchronous(): default
Returns default
Inherited from default.setSynchronous
- Defined in src/game/game/inspection/InfoProvider.ts:231

subscribeRefreshOn

subscribeRefreshOn<E>(emitterOrBus: E, ...events: (keyof Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>)[]): default
Marks this info provider as to subscribe refresh events to the given host.
Note: Any existing initialized components will not be retroactively subscribed.
Type Parameters
- E extends EmitterOrBus
Parameters
- emitterOrBus: E
- Rest ...events: (keyof Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>)[]
Returns default
Inherited from default.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:251
subscribeRefreshOn<E, K>(emitter: WeakRef<E>, ...events: (keyof Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>)[]): default
Type Parameters
- E extends HostOrHostClass
- K extends string | number | symbol
Parameters
- emitter: WeakRef<E>
- Rest ...events: (keyof Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>)[]
Returns default
Inherited from default.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:252
subscribeRefreshOn<E, K>(emitterOrBus: E, ...args: [...events: K[], predicate: ((...params: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>, ...args: Extract<LiterallyJustTheSameThing<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>>, any[]>[]]) => boolean)]): default
Marks this info provider as to subscribe refresh events to the given host.
Note: Any existing initialized components will not be retroactively subscribed.
Type Parameters
- E extends EmitterOrBus
- K extends string | number | symbol
Parameters
- emitterOrBus: E
- Rest ...args: [...events: K[], predicate: ((...params: [host: HostFromHostOrHostClass<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>, ...args: Extract<LiterallyJustTheSameThing<Parameters<Extract<Extract<Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>[K], AnyFunction<any>>, AnyFunction<any>>>>, any[]>[]]) => boolean)]
Returns default
Inherited from default.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:258
subscribeRefreshOn<E>(emitterOrBus: E, ...args: [...events: (keyof Events<E extends EventBus ? ReturnType<{
    0(): default<any, any, any, any, any>;
    1(): default;
    10(): default<any>;
    11(): Game;
    12(): default<number>;
    13(): default;
    14(): default;
    15(): default;
    16(): default;
    17(): default.Events;
    18(): default;
    19(): default;
    2(): default;
    20(): MilestoneManager;
    21(): default;
    22(): default;
    23(): default;
    24(): default;
    25(): default;
    26(): default;
    27(): default.Events;
    28(): default;
    29(): default;
    3(): default;
    30(): default;
    31(): default;
    32(): default;
    33(): Ui;
    34(): default;
    35(): default;
    36(): default;
    4(): default;
    5(): default;
    6(): default;
    7(): default;
    8(): default<unknown, number, unknown, unknown>;
    9(): default<unknown, number, unknown, unknown>;
}[E]> : E>)[], observer: Observer<any>]): default
Marks this info provider as to subscribe refresh events to the given host.
Note: Any existing initialized components will not be retroactively subscribed.
Type Parameters
- E extends EmitterOrBus
Parameters
- emitterOrBus: E
- Rest ...args: [...events: (keyof Events<E extends EventBus ? ReturnType<{
      0(): default<any, any, any, any, any>;
      1(): default;
      10(): default<any>;
      11(): Game;
      12(): default<number>;
      13(): default;
      14(): default;
      15(): default;
      16(): default;
      17(): default.Events;
      18(): default;
      19(): default;
      2(): default;
      20(): MilestoneManager;
      21(): default;
      22(): default;
      23(): default;
      24(): default;
      25(): default;
      26(): default;
      27(): default.Events;
      28(): default;
      29(): default;
      3(): default;
      30(): default;
      31(): default;
      32(): default;
      33(): Ui;
      34(): default;
      35(): default;
      36(): default;
      4(): default;
      5(): default;
      6(): default;
      7(): default;
      8(): default<unknown, number, unknown, unknown>;
      9(): default<unknown, number, unknown, unknown>;
  }[E]> : E>)[], observer: Observer<any>]
Returns default
Inherited from default.subscribeRefreshOn
- Defined in src/game/game/inspection/InfoProvider.ts:264

subscribeRefreshOnTick

subscribeRefreshOnTick(observer: Observer<any>): default
Parameters
- observer: Observer<any>
Returns default
Inherited from default.subscribeRefreshOnTick
- Defined in src/game/game/inspection/InfoProvider.ts:241
subscribeRefreshOnTick(predicate: ((...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]) => boolean)): default
Parameters
- predicate: ((...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]) => boolean)
  - - (...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]): boolean
    - Parameters
      
      Rest ...params: [host: Game, tickFlag: TickFlag, ticks: number, dueToAction: boolean]
      
      Returns boolean
Returns default
Inherited from default.subscribeRefreshOnTick
- Defined in src/game/game/inspection/InfoProvider.ts:242

`Static` create

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

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

`Static` dynamic

dynamic<T>(observer: Observer<T>, supplier: ((value: T) => undefined | InfoProvider)): SimpleInfoProvider
Type Parameters
- T
Parameters
- observer: Observer<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:99

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

`Static` of

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

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

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

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

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

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

value: ItemType

Returns default

Parameters

value: default

Returns default

Properties

Protected Optional component

Protected Optional context

Protected Optional Readonly description

Protected Readonly entityType

Readonly event

Protected Readonly type

Protected Optional Readonly value

Static multiTextParagraph

Methods

addDetails

Parameters

Rest ...details: symbol[]

Returns default

get

Parameters

context: InfoProviderContext

Returns ArrayOr<TranslationGenerator | InfoProvider>

getClass

Returns string[]

getDefaultDisplayLevel

Parameters

_context: InfoProviderContext

Returns InfoDisplayLevel | Set<InfoDisplayLevel>

Protected getDescription

Parameters

type: ItemType

Returns IItemDescription

getDisplayLevel

Parameters

context: InfoProviderContext

Returns Set<InfoDisplayLevel>

Protected getEntityType

Returns Item

getIcon

Returns undefined | string | IIcon

Protected getUse

Parameters

description: IItemDescription

action: ActionType

Returns default

Protected getUseDisplayLevel

Parameters

action: ActionType

context: InfoProviderContext

Returns InfoDisplayLevel

Protected getUseInfoHandlers

Protected getUses

Parameters

description: IItemDescription

Returns ActionType[]

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

`Protected` `Optional` component

`Protected` `Optional` context

`Protected` `Optional` `Readonly` description

`Protected` `Readonly` entityType

`Readonly` event

`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

data: {
lastInfoSleep: number;
} = ...

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

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

`Optional` icon: string | IIcon