Class default

Hierarchy

default

Index

Constructors

constructor

Methods

clearCacheEntry create get getList getReferenceType inspect reset resolve tooltip get getReferenceType isEnumReference

Constructors

constructor

new default(game: Game): default
Parameters
- game: Game
Returns default
- Defined in src/game/game/reference/ReferenceManager.ts:102

Methods

clearCacheEntry

clearCacheEntry(referenceId: undefined | string | number): void
Parameters
- referenceId: undefined | string | number
Returns void
- Defined in src/game/game/reference/ReferenceManager.ts:109

create

create(): number
Returns number
- Defined in src/game/game/reference/ReferenceManager.ts:105

get

get(thing: default): undefined | [id: number, type: Item, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
Parameters
- thing: default
Returns undefined | [id: number, type: Item, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
- Defined in src/game/game/reference/ReferenceManager.ts:148
get(thing: default): undefined | [id: number, type: Doodad, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
Parameters
- thing: default
Returns undefined | [id: number, type: Doodad, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
- Defined in src/game/game/reference/ReferenceManager.ts:149
get(thing: default): undefined | [id: number, type: Creature, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
Parameters
- thing: default
Returns undefined | [id: number, type: Creature, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
- Defined in src/game/game/reference/ReferenceManager.ts:150
get(thing: default): undefined | [id: number, type: NPC, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
Parameters
- thing: default
Returns undefined | [id: number, type: NPC, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]
- Defined in src/game/game/reference/ReferenceManager.ts:151
get(thing: Referenceable): undefined | Reference<ReferenceableReferenceTypes>
Parameters
- thing: Referenceable
Returns undefined | Reference<ReferenceableReferenceTypes>
- Defined in src/game/game/reference/ReferenceManager.ts:152

getList

getList(type: ReferenceType, gameIsland?: default): default | default | default | default | default | default | EquipType[] | default[] | IteratorObject<default> | (string | ActionType)[] | readonly string[]
Parameters
- type: ReferenceType
- Optional gameIsland: default
Returns default | default | default | default | default | default | EquipType[] | default[] | IteratorObject<default> | (string | ActionType)[] | readonly string[]
- Defined in src/game/game/reference/ReferenceManager.ts:120

getReferenceType

getReferenceType(thing: Value<IReferenceTypeMap>): ReferenceType
Parameters
- thing: Value<IReferenceTypeMap>
Returns ReferenceType
- Defined in src/game/game/reference/ReferenceManager.ts:157

inspect

inspect<REFTYPE>(reference: Reference<REFTYPE>, context?: InfoProviderContext): undefined | default<any>
Type Parameters
- REFTYPE extends ReferenceType
Parameters
- reference: Reference<REFTYPE>
- Optional context: InfoProviderContext
Returns undefined | default<any>
- Defined in src/game/game/reference/ReferenceManager.ts:238
inspect(reference: Reference, context?: InfoProviderContext): undefined | default<any>
Parameters
- reference: Reference
- Optional context: InfoProviderContext
Returns undefined | default<any>
- Defined in src/game/game/reference/ReferenceManager.ts:239

reset

reset(): void
Returns void
- Defined in src/game/game/reference/ReferenceManager.ts:115

resolve

resolve<REFTYPE>(reference?: Reference<REFTYPE>, gameIsland?: default): undefined | IReferenceTypeMap[REFTYPE]
Type Parameters
- REFTYPE extends ReferenceType
Parameters
- Optional reference: Reference<REFTYPE>
- Optional gameIsland: default
Returns undefined | IReferenceTypeMap[REFTYPE]
- Defined in src/game/game/reference/ReferenceManager.ts:161
resolve(reference?: Reference, gameIsland?: default): undefined | default | default | default | default | default | default | default | default | [Skill, SkillType] | [Milestone, Milestone] | [Recipe, ItemType] | [ItemType, ItemType | ItemTypeExtra] | [Dismantle, ItemType] | [Stat, Stat] | [Action, ActionId] | [EquipSlot, EquipType] | [Deity, Deity] | [Quality, Quality] | [Magic, MagicalPropertyIdentityHash] | [Status, StatusType] | [Damage, DamageType]
Parameters
- Optional reference: Reference
- Optional gameIsland: default
Returns undefined | default | default | default | default | default | default | default | default | [Skill, SkillType] | [Milestone, Milestone] | [Recipe, ItemType] | [ItemType, ItemType | ItemTypeExtra] | [Dismantle, ItemType] | [Stat, Stat] | [Action, ActionId] | [EquipSlot, EquipType] | [Deity, Deity] | [Quality, Quality] | [Magic, MagicalPropertyIdentityHash] | [Status, StatusType] | [Damage, DamageType]
- Defined in src/game/game/reference/ReferenceManager.ts:162

tooltip

tooltip(reference: Reference, initializer?: ((tooltip: default, handler: default) => any), context?: InfoProviderContext): ((tooltip: default) => Promise<void>)
Parameters
- reference: Reference
- Optional initializer: ((tooltip: default, handler: default) => any)
  - - (tooltip: default, handler: default): any
    - Parameters
      
      tooltip: default
      
      handler: default
      
      Returns any
- Optional context: InfoProviderContext
Returns ((tooltip: default) => Promise<void>)
- - (tooltip: default): Promise<void>
  - Parameters
    - tooltip: default
    Returns Promise<void>
- Defined in src/game/game/reference/ReferenceManager.ts:249

`Static` get

get(thing: Referenceable): undefined | Reference
Parameters
- thing: Referenceable
Returns undefined | Reference
- Defined in src/game/game/reference/ReferenceManager.ts:51

`Static` getReferenceType

getReferenceType(thing: Value<IReferenceTypeMap>): ReferenceType
Parameters
- thing: Value<IReferenceTypeMap>
Returns ReferenceType
- Defined in src/game/game/reference/ReferenceManager.ts:62

`Static` isEnumReference

isEnumReference(type: ReferenceType): type is Skill | Milestone | Recipe | ItemType | Dismantle | Stat | Action | EquipSlot | Deity | Quality | Magic | Status | Damage
Parameters
- type: ReferenceType
Returns type is Skill | Milestone | Recipe | ItemType | Dismantle | Stat | Action | EquipSlot | Deity | Quality | Magic | Status | Damage
- Defined in src/game/game/reference/ReferenceManager.ts:47

Class default

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

game: Game

Returns default

Methods

clearCacheEntry

Parameters

referenceId: undefined | string | number

Returns void

create

Returns number

get

Parameters

thing: default

Returns undefined | [id: number, type: Item, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]

Parameters

thing: default

Returns undefined | [id: number, type: Doodad, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]

Parameters

thing: default

Returns undefined | [id: number, type: Creature, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]

Parameters

thing: default

Returns undefined | [id: number, type: NPC, context?: ReferenceContext, islandId?: `${number},${number}`, objectId?: number]

Parameters

thing: Referenceable

Returns undefined | Reference<ReferenceableReferenceTypes>

getList

Parameters

type: ReferenceType

Optional gameIsland: default

Returns default | default | default | default | default | default | EquipType[] | default[] | IteratorObject<default> | (string | ActionType)[] | readonly string[]

getReferenceType

Parameters

thing: Value<IReferenceTypeMap>

Returns ReferenceType

inspect

Type Parameters

REFTYPE extends ReferenceType

Parameters

reference: Reference<REFTYPE>

Optional context: InfoProviderContext

Returns undefined | default<any>

Parameters

reference: Reference

Optional context: InfoProviderContext

Returns undefined | default<any>

reset

Returns void

resolve

Type Parameters

REFTYPE extends ReferenceType

Parameters

Optional reference: Reference<REFTYPE>

Optional gameIsland: default

Returns undefined | IReferenceTypeMap[REFTYPE]

Parameters

Optional reference: Reference

Optional gameIsland: default

tooltip

Parameters

reference: Reference

Optional initializer: ((tooltip: default, handler: default) => any)

Parameters

tooltip: default

handler: default

Returns any

Optional context: InfoProviderContext

Returns ((tooltip: default) => Promise<void>)

Parameters

tooltip: default

Returns Promise<void>

Static get

Parameters

`Optional` gameIsland: default

`Optional` context: InfoProviderContext

`Optional` context: InfoProviderContext

`Optional` reference: Reference<REFTYPE>

`Optional` gameIsland: default

`Optional` reference: Reference

`Optional` gameIsland: default

`Optional` initializer: ((tooltip: default, handler: default) => any)

`Optional` context: InfoProviderContext

`Static` get

`Static` getReferenceType

`Static` isEnumReference