Class default

Hierarchy

default

Index

Constructors

constructor

new default(id: string): default
Parameters
- id: string
Returns default
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:42

Properties

`Readonly` actionIds

actionIds: string[] = []

`Readonly` actionIndices

actionIndices: Record<string, number> = {}

`Readonly` actions

actions: [string, default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>][] = []

`Readonly` id

id: string

Methods

add

add(registrar: default): default
Parameters
- registrar: default
Returns default
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:67
add<REQUIREMENTS>(id: string | number, action: default<REQUIREMENTS, IUsableActionDefinition<REQUIREMENTS>>): default
Type Parameters
- REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS>
Parameters
- id: string | number
- action: default<REQUIREMENTS, IUsableActionDefinition<REQUIREMENTS>>
Returns default
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:68

byId

byId(id?: ActionId): undefined | default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>
Parameters
- Optional id: ActionId
Returns undefined | default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:46

createContextMenu

createContextMenu(provided: IUsableActionPossibleUsing, contextMenu?: default<ActionId>, context?: ActionDisplayLevel, initialiser?: ((contextMenu: default<ActionId>) => any)): undefined | default<ActionId>
Parameters
- provided: IUsableActionPossibleUsing
- contextMenu: default<ActionId> = ...
- context: ActionDisplayLevel = ActionDisplayLevel.Always
- Optional initialiser: ((contextMenu: default<ActionId>) => any)
  - - (contextMenu: default<ActionId>): any
    - Parameters
      
      contextMenu: default<ActionId>
      
      Returns any
Returns undefined | default<ActionId>
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:122

filter

filter(filter: ((action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>, id: string) => any)): default
Parameters
- filter: ((action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>, id: string) => any)
  - - (action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>, id: string): any
    - Parameters
      
      action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>
      
      id: string
      
      Returns any
Returns default
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:50

setContextMenuInitializer

setContextMenuInitializer(initializer?: ((menu: default<string | number | symbol>) => any)): default
Parameters
- Optional initializer: ((menu: default<string | number | symbol>) => any)
  - - (menu: default<string | number | symbol>): any
    - Parameters
      
      menu: default<string | number | symbol>
      
      Returns any
Returns default
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:62

showContextMenu

showContextMenu(provided: IUsableActionPossibleUsing, contextMenu?: default<ActionId>, context?: ActionDisplayLevel, initialiser?: ((contextMenu: default<ActionId>) => any), position?: IVector2): undefined | default<ActionId>
Parameters
- provided: IUsableActionPossibleUsing
- Optional contextMenu: default<ActionId>
- Optional context: ActionDisplayLevel
- Optional initialiser: ((contextMenu: default<ActionId>) => any)
  - - (contextMenu: default<ActionId>): any
    - Parameters
      
      contextMenu: default<ActionId>
      
      Returns any
- Optional position: IVector2
Returns undefined | default<ActionId>
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:90

`Static` getContextMenuActionExecutionContext

getContextMenuActionExecutionContext(provided: IUsableActionPossibleUsing): IUsableActionExecutionContext
Parameters
- provided: IUsableActionPossibleUsing
Returns IUsableActionExecutionContext
- Defined in src/game/game/entity/action/usable/UsableActionRegistrar.ts:111

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: string

Returns default

Properties

Readonly actionIds

Readonly actionIndices

Readonly actions

Readonly id

Methods

add

Parameters

registrar: default

Returns default

Type Parameters

REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS>

Parameters

id: string | number

action: default<REQUIREMENTS, IUsableActionDefinition<REQUIREMENTS>>

Returns default

byId

Parameters

Optional id: ActionId

Returns undefined | default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>

createContextMenu

Parameters

provided: IUsableActionPossibleUsing

contextMenu: default<ActionId> = ...

context: ActionDisplayLevel = ActionDisplayLevel.Always

Optional initialiser: ((contextMenu: default<ActionId>) => any)

Parameters

contextMenu: default<ActionId>

Returns any

Returns undefined | default<ActionId>

filter

Parameters

filter: ((action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>, id: string) => any)

Parameters

action: default<IUsableActionRequirements, IUsableActionDefinition<IUsableActionRequirements>>

id: string

Returns any

Returns default

setContextMenuInitializer

Parameters

Optional initializer: ((menu: default<string | number | symbol>) => any)

Parameters

menu: default<string | number | symbol>

Returns any

Returns default

showContextMenu

Parameters

provided: IUsableActionPossibleUsing

Optional contextMenu: default<ActionId>

Optional context: ActionDisplayLevel

Optional initialiser: ((contextMenu: default<ActionId>) => any)

Parameters

contextMenu: default<ActionId>

Returns any

Optional position: IVector2

Returns undefined | default<ActionId>

Static getContextMenuActionExecutionContext

Parameters

provided: IUsableActionPossibleUsing

Returns IUsableActionExecutionContext

Settings

Member Visibility

Theme

`Readonly` actionIds

`Readonly` actionIndices

`Readonly` actions

`Readonly` id

`Optional` id: ActionId

`Optional` initialiser: ((contextMenu: default<ActionId>) => any)

`Optional` initializer: ((menu: default<string | number | symbol>) => any)

`Optional` contextMenu: default<ActionId>

`Optional` context: ActionDisplayLevel

`Optional` initialiser: ((contextMenu: default<ActionId>) => any)

`Optional` position: IVector2

`Static` getContextMenuActionExecutionContext