Class ItemUseContext

Hierarchy

InfoProviderContext
- ItemUseContext

Index

Constructors

constructor

new ItemUseContext(item?: default): ItemUseContext
Parameters
- Optional item: default
Returns ItemUseContext
Overrides InfoProviderContext.constructor
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:138

Properties

maxDisplayLevel

maxDisplayLevel: InfoDisplayLevel

`Readonly` type

type: InfoProviderContextType | keyof InfoProviderContextRegistration

`Static` `Readonly` GENERIC

GENERIC: (new (...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]) => InfoProviderContext) = ...

Type declaration

- new (...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]): InfoProviderContext
- Parameters
  - Rest ...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]
  Returns InfoProviderContext

`Static` `Readonly` TOOLTIP

TOOLTIP: (new (...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]) => InfoProviderContext) = ...

Type declaration

- new (...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]): InfoProviderContext
- Parameters
  - Rest ...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]
  Returns InfoProviderContext

Accessors

inspector

get inspector(): undefined | default
Returns undefined | default
Inherited from InfoProviderContext.inspector
- Defined in src/game/game/inspection/InfoProviderContext.ts:50

item

get item(): undefined | default
Returns undefined | default
- Defined in src/game/game/inspection/infoProviders/item/ItemUses.ts:134

Methods

as

as<TYPE>(type: TYPE): undefined | InfoProviderContextRegistration[TYPE]
Type Parameters
- TYPE extends keyof InfoProviderContextRegistration
Parameters
- type: TYPE
Returns undefined | InfoProviderContextRegistration[TYPE]
Inherited from InfoProviderContext.as
- Defined in src/game/game/inspection/InfoProviderContext.ts:75
as(type: InfoProviderContextType): undefined | InfoProviderContext
Parameters
- type: InfoProviderContextType
Returns undefined | InfoProviderContext
Inherited from InfoProviderContext.as
- Defined in src/game/game/inspection/InfoProviderContext.ts:76

equals

equals(b: InfoProviderContext & Partial<ItemUseContext>): boolean
Parameters
- b: InfoProviderContext & Partial<ItemUseContext>
Returns boolean
Inherited from InfoProviderContext.equals
- Defined in src/game/game/inspection/InfoProviderContext.ts:85

is

is(...types: (InfoProviderContextType | keyof InfoProviderContextRegistration)[]): boolean
Parameters
- Rest ...types: (InfoProviderContextType | keyof InfoProviderContextRegistration)[]
Returns boolean
Inherited from InfoProviderContext.is
- Defined in src/game/game/inspection/InfoProviderContext.ts:71

setMaxDisplayLevel

setMaxDisplayLevel(maxDisplayLevel?: InfoDisplayLevel): ItemUseContext
Parameters
- Optional maxDisplayLevel: InfoDisplayLevel
Returns ItemUseContext
Inherited from InfoProviderContext.setMaxDisplayLevel
- Defined in src/game/game/inspection/InfoProviderContext.ts:91

`Static` init

init<ID>(id: ID, saved: InfoProviderContextInstance<ID>): InfoProviderContextInstance<ID>
Type Parameters
- ID extends InfoProviderContextType | keyof InfoProviderContextRegistration
Parameters
- id: ID
- saved: InfoProviderContextInstance<ID>
Returns InfoProviderContextInstance<ID>
Inherited from InfoProviderContext.init
- Defined in src/game/game/inspection/InfoProviderContext.ts:39

`Static` register

register<ID>(id: ID, cls: Class<InfoProviderContextRegistration[ID], any[]>): void
Type Parameters
- ID extends keyof InfoProviderContextRegistration
Parameters
- id: ID
- cls: Class<InfoProviderContextRegistration[ID], any[]>
Returns void
Inherited from InfoProviderContext.register
- Defined in src/game/game/inspection/InfoProviderContext.ts:35

Class ItemUseContext

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional item: default

Returns ItemUseContext

Properties

maxDisplayLevel

Readonly type

Static Readonly GENERIC

Type declaration

Parameters

Rest ...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]

Returns InfoProviderContext

Static Readonly TOOLTIP

Type declaration

Parameters

Rest ...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]

Returns InfoProviderContext

Accessors

inspector

Returns undefined | default

item

Returns undefined | default

Methods

as

Type Parameters

TYPE extends keyof InfoProviderContextRegistration

Parameters

type: TYPE

Returns undefined | InfoProviderContextRegistration[TYPE]

Parameters

type: InfoProviderContextType

Returns undefined | InfoProviderContext

equals

Parameters

b: InfoProviderContext & Partial<ItemUseContext>

Returns boolean

is

Parameters

Rest ...types: (InfoProviderContextType | keyof InfoProviderContextRegistration)[]

Returns boolean

setMaxDisplayLevel

Parameters

Optional maxDisplayLevel: InfoDisplayLevel

Returns ItemUseContext

Static init

Type Parameters

ID extends InfoProviderContextType | keyof InfoProviderContextRegistration

Parameters

id: ID

saved: InfoProviderContextInstance<ID>

Returns InfoProviderContextInstance<ID>

Static register

Type Parameters

ID extends keyof InfoProviderContextRegistration

Parameters

id: ID

cls: Class<InfoProviderContextRegistration[ID], any[]>

Returns void

Settings

Member Visibility

Theme

`Optional` item: default

`Readonly` type

`Static` `Readonly` GENERIC

`Rest` ...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]

`Static` `Readonly` TOOLTIP

`Rest` ...args: [inspector?: default, maxDisplayLevel?: InfoDisplayLevel]

`Rest` ...types: (InfoProviderContextType | keyof InfoProviderContextRegistration)[]

`Optional` maxDisplayLevel: InfoDisplayLevel

`Static` init

`Static` register