Class default

Hierarchy

default<IVector2>
- default

Constructors

constructor

new default(island: default | IVector2, context?: InfoProviderContext, title?: boolean): default
Parameters
- island: default | IVector2
- Optional context: InfoProviderContext
- title: boolean = true
Returns default
Overrides default.constructor
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:67

Properties

`Protected` `Optional` component

component?: default<HTMLElement>

`Protected` `Optional` context

context?: InfoProviderContext

`Readonly` event

event: IEventEmitter<default, IInfoProviderEvents>

`Readonly` subscribeRefreshOn

subscribeRefreshOn: IRegistrar<default> = ...

`Readonly` type

type: InspectType

`Readonly` value

value: IVector2

`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 Inspection.human
- Defined in src/game/game/inspection/Inspection.ts:74

island

get island(): undefined | default
Returns undefined | default
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:63

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

`Protected` createIdFromVector3

createIdFromVector3(vec3: IVector3): string
Parameters
- vec3: IVector3
Returns string
Inherited from default.createIdFromVector3
- Defined in src/game/game/inspection/Inspection.ts:130

get

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

getBorder

getBorder(): undefined | string
Returns undefined | string
Inherited from default.getBorder
- Defined in src/game/game/inspection/Inspection.ts:89

getClass

getClass(context: InfoProviderContext): string[]
Parameters
- context: InfoProviderContext
Returns string[]
Inherited from default.getClass
- Defined in src/game/game/inspection/Inspection.ts:85

`Protected` `Optional` getColorContext

getColorContext(context: InfoProviderContext): undefined | default | SimpleInfoProvider
Parameters
- context: InfoProviderContext
Returns undefined | default | SimpleInfoProvider
Inherited from default.getColorContext
- Defined in src/game/game/inspection/Inspection.ts:99

`Protected` getContent

getContent(context: InfoProviderContext): ArrayOr<undefined | TranslationGenerator | InfoProvider>
Parameters
- context: InfoProviderContext
Returns ArrayOr<undefined | TranslationGenerator | InfoProvider>
Overrides default.getContent
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:83

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

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

getIcon

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

`Protected` `Optional` getIconComponent

getIconComponent(context: InfoProviderContext): undefined | default<HTMLElement>
Parameters
- context: InfoProviderContext
Returns undefined | default<HTMLElement>
Inherited from default.getIconComponent
- Defined in src/game/game/inspection/Inspection.ts:101

getId

getId(): string
Returns a string that should differentiate this inspection from other inspections of the same type.

Returns string
Overrides default.getId
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:71

getPriority

getPriority(): number
Returns number
Inherited from default.getPriority
- Defined in src/game/game/inspection/Inspection.ts:93

`Protected` getSubtitle

getSubtitle(context: InfoProviderContext): undefined | default | SimpleInfoProvider
Parameters
- context: InfoProviderContext
Returns undefined | default | SimpleInfoProvider
Overrides default.getSubtitle
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:79

`Protected` getTitle

getTitle(context: InfoProviderContext): undefined | default | SimpleInfoProvider
Parameters
- context: InfoProviderContext
Returns undefined | default | SimpleInfoProvider
Overrides default.getTitle
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:75

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/Inspection.ts:134

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

renderHints

renderHints(hints: InspectionTooltipHints): void
Parameters
- hints: InspectionTooltipHints
Returns void
Inherited from default.renderHints
- Defined in src/game/game/inspection/Inspection.ts:128

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

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

createAnyHandler(...handlers: ((inspectType: InspectType, ...args: any[]) => undefined | number | boolean)[]): ((type: InspectType, ...args: any[]) => boolean)
Parameters
- Rest ...handlers: ((inspectType: InspectType, ...args: any[]) => undefined | number | boolean)[]
Returns ((type: InspectType, ...args: any[]) => boolean)
- - (type: InspectType, ...args: any[]): boolean
  - Parameters
    - type: InspectType
    - Rest ...args: any[]
    Returns boolean
Inherited from default.createAnyHandler
- Defined in src/game/game/inspection/Inspection.ts:55

`Static` createEnumReferenceHandler

createEnumReferenceHandler<R, E>(referenceType: R, enumObject: Record<string, E>, predicate?: ((reference: [R, E], context?: InfoProviderContext) => any)): ((type: InspectType, value: unknown, context?: InfoProviderContext) => boolean)
Type Parameters
- R extends ReferenceType
- E
Parameters
- referenceType: R
- enumObject: Record<string, E>
- Optional predicate: ((reference: [R, E], context?: InfoProviderContext) => any)
  - - (reference: [R, E], context?: InfoProviderContext): any
    - Parameters
      
      reference: [R, E]
      
      Optional context: InfoProviderContext
      
      Returns any
Returns ((type: InspectType, value: unknown, context?: InfoProviderContext) => boolean)
- - (type: InspectType, value: unknown, context?: InfoProviderContext): boolean
  - Parameters
    - type: InspectType
    - value: unknown
    - Optional context: InfoProviderContext
    Returns boolean
Inherited from default.createEnumReferenceHandler
- Defined in src/game/game/inspection/Inspection.ts:47

`Static` createReferenceHandler

createReferenceHandler<REFTYPE>(referenceType: REFTYPE, handler?: ((resolvedReference: EnumReferenceResolved<REFTYPE>, context?: InfoProviderContext) => any)): ((type: InspectType, value: unknown, context?: InfoProviderContext) => boolean)
Type Parameters
- REFTYPE extends Skill | Milestone | Recipe | ItemType | Dismantle | Stat | Action | EquipSlot | Deity | Quality | Magic | Status | Damage
Parameters
- referenceType: REFTYPE
- Optional handler: ((resolvedReference: EnumReferenceResolved<REFTYPE>, context?: InfoProviderContext) => any)
  - - (resolvedReference: EnumReferenceResolved<REFTYPE>, context?: InfoProviderContext): any
    - Parameters
      
      resolvedReference: EnumReferenceResolved<REFTYPE>
      
      Optional context: InfoProviderContext
      
      Returns any
Returns ((type: InspectType, value: unknown, context?: InfoProviderContext) => boolean)
- - (type: InspectType, value: unknown, context?: InfoProviderContext): boolean
  - Parameters
    - type: InspectType
    - value: unknown
    - Optional context: InfoProviderContext
    Returns boolean
Inherited from default.createReferenceHandler
- Defined in src/game/game/inspection/Inspection.ts:59

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

getDefaultPriority(inspectType: InspectType): number
Parameters
- inspectType: InspectType
Returns number
Inherited from default.getDefaultPriority
- Defined in src/game/game/inspection/Inspection.ts:69

`Static` getIslandName

getIslandName(island?: default, useGenerated?: boolean): default
Parameters
- Optional island: default
- useGenerated: boolean = false
Returns default
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:43

`Static` handles

handles(type: InspectType, island: unknown): boolean
Parameters
- type: InspectType
- island: unknown
Returns boolean
- Defined in src/game/game/inspection/inspections/IslandInspection.ts:59

`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

`Static` verifyHumanity

verifyHumanity(_: any, context?: InfoProviderContext): boolean
Parameters
- _: any
- Optional context: InfoProviderContext
Returns boolean
Inherited from default.verifyHumanity
- Defined in src/game/game/inspection/Inspection.ts:65

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

island: default | IVector2

Optional context: InfoProviderContext

title: boolean = true

Returns default

Properties

Protected Optional component

Protected Optional context

Readonly event

Readonly subscribeRefreshOn

Readonly type

Readonly value

Static multiTextParagraph

Accessors

Protected human

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

island

Returns undefined | default

Methods

appendTo

Parameters

place: default<HTMLElement>

Returns default<HTMLElement>

Protected createIdFromVector3

Parameters

vec3: IVector3

Returns string

get

Parameters

context: InfoProviderContext

Returns ArrayOr<TranslationGenerator | InfoProvider>

getBorder

Returns undefined | string

getClass

Parameters

context: InfoProviderContext

Returns string[]

Protected Optional getColorContext

Parameters

context: InfoProviderContext

Returns undefined | default | SimpleInfoProvider

Protected getContent

Parameters

context: InfoProviderContext

Returns ArrayOr<undefined | TranslationGenerator | InfoProvider>

getDefaultDisplayLevel

Parameters

_context: InfoProviderContext

Returns InfoDisplayLevel | Set<InfoDisplayLevel>

getDisplayLevel

Parameters

context: InfoProviderContext

Returns Set<InfoDisplayLevel>

getIcon

Returns undefined | string | IIcon

Protected Optional getIconComponent

Parameters

context: InfoProviderContext

Returns undefined | default<HTMLElement>

getId

Returns string

getPriority

Returns number

Protected getSubtitle

Parameters

context: InfoProviderContext

Returns undefined | default | SimpleInfoProvider

Protected getTitle

Parameters

context: InfoProviderContext

Returns undefined | default | SimpleInfoProvider

`Optional` context: InfoProviderContext

`Protected` `Optional` component

`Protected` `Optional` context

`Readonly` event

`Readonly` subscribeRefreshOn

`Readonly` type

`Readonly` value

`Static` multiTextParagraph

`Protected` human

`Protected` createIdFromVector3

`Protected` `Optional` getColorContext

`Protected` getContent

`Protected` `Optional` getIconComponent

`Protected` getSubtitle

`Protected` getTitle

`Protected` initChildTextComponent

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

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

`Optional` icon: string | IIcon

`Protected` shouldDisplayWhenEmpty

`Static` create

`Rest` ...translations: TranslationGenerator[]

`Static` createAnyHandler

`Rest` ...handlers: ((inspectType: InspectType, ...args: any[]) => undefined | number | boolean)[]

`Rest` ...args: any[]