Class default<REQUIREMENTS, DEFINITION>

Create a basic usable action:

UsableAction.create({...definition});

If your action has item/doodad/creature/npc requirements:

UsableAction.requiring({...requirements})
    .create({...definition});

To learn about action definitions, see IUsableActionDefinitionBase

Type Parameters

REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements
DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>

Hierarchy

Host<IUsableActionEvents>
- default

Constructors

constructor

new default<REQUIREMENTS, DEFINITION>(requirements: REQUIREMENTS, definition: DEFINITION): default<REQUIREMENTS, DEFINITION>
Type Parameters
- REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS> = IUsableActionRequirements
- DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>
Parameters
- requirements: REQUIREMENTS
- definition: DEFINITION
Returns default<REQUIREMENTS, DEFINITION>
Overrides EventEmitter.Host<IUsableActionEvents>.constructor
- Defined in src/game/game/entity/action/usable/UsableAction.ts:82

Properties

`Readonly` definition

definition: DEFINITION

`Readonly` event

event: IEventEmitter<default<REQUIREMENTS, DEFINITION>, IUsableActionEvents>

id

id: ActionId

`Readonly` observe

observe: IRegistrar<default<REQUIREMENTS, DEFINITION>> = ...

`Readonly` requirements

requirements: REQUIREMENTS

Accessors

itemRequirementObject

get itemRequirementObject(): undefined | IUsableActionItemRequirement
Returns undefined | IUsableActionItemRequirement
- Defined in src/game/game/entity/action/usable/UsableAction.ts:577

Methods

canUseOnMove

canUseOnMove(): boolean
Returns boolean
- Defined in src/game/game/entity/action/usable/UsableAction.ts:646

canUseOnMoveWhenDiscovered

canUseOnMoveWhenDiscovered(): boolean
Returns boolean
- Defined in src/game/game/entity/action/usable/UsableAction.ts:642

execute

execute(player: default, provided: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext | UsableActionExecutionContext): boolean
Parameters
- player: default
- provided: IUsableActionUsing<REQUIREMENTS>
- context: IUsableActionExecutionContext | UsableActionExecutionContext
Returns boolean
- Defined in src/game/game/entity/action/usable/UsableAction.ts:98

getAlignment

getAlignment(using?: IUsableActionPossibleUsing): DeityReal[]
Parameters
- using: IUsableActionPossibleUsing = {}
Returns DeityReal[]
- Defined in src/game/game/entity/action/usable/UsableAction.ts:662

getContextualLevel

getContextualLevel(using?: IUsableActionPossibleUsing, parentMenuId: string, actionExecutionContext: IUsableActionExecutionContext): number
Parameters
- using: IUsableActionPossibleUsing = {}
- parentMenuId: string
- actionExecutionContext: IUsableActionExecutionContext
Returns number
- Defined in src/game/game/entity/action/usable/UsableAction.ts:609

getCreature

getCreature(player: default, provided?: IUsableActionPossibleUsing): undefined | false | default
Parameters
- player: default
- Optional provided: IUsableActionPossibleUsing
Returns undefined | false | default
- Defined in src/game/game/entity/action/usable/UsableAction.ts:460

getDoodad

getDoodad(player: default, provided?: IUsableActionPossibleUsing): undefined | false | default
Parameters
- player: default
- Optional provided: IUsableActionPossibleUsing
Returns undefined | false | default
- Defined in src/game/game/entity/action/usable/UsableAction.ts:408

getFindItemCannotUse

getFindItemCannotUse(): IUsableActionNotUsable[]
Returns IUsableActionNotUsable[]
- Defined in src/game/game/entity/action/usable/UsableAction.ts:283

getHighlightSelectors

getHighlightSelectors(using?: IUsableActionPossibleUsing): (undefined | HighlightSelector)[]
Parameters
- Optional using: IUsableActionPossibleUsing
Returns (undefined | HighlightSelector)[]
- Defined in src/game/game/entity/action/usable/UsableAction.ts:547

getIcon

getIcon(provided: IUsableActionPossibleUsing, context?: UsableActionDisplayContext): undefined | IIcon
Parameters
- provided: IUsableActionPossibleUsing
- context: UsableActionDisplayContext = UsableActionDisplayContext.Use
Returns undefined | IIcon
- Defined in src/game/game/entity/action/usable/UsableAction.ts:512

getInteractionDistance

getInteractionDistance(provided?: IUsableActionPossibleUsing): undefined | InteractionDistance
Parameters
- Optional provided: IUsableActionPossibleUsing
Returns undefined | InteractionDistance
- Defined in src/game/game/entity/action/usable/UsableAction.ts:666

getInternalActionType

getInternalActionType(): undefined | ActionType
Returns undefined | ActionType
- Defined in src/game/game/entity/action/usable/UsableAction.ts:653

getItem

getItem(player: default, provided?: IUsableActionPossibleUsing, fullUsabilityCheck?: boolean): undefined | false | default
Parameters
- player: default
- Optional provided: IUsableActionPossibleUsing
- fullUsabilityCheck: boolean = true
Returns undefined | false | default
- Defined in src/game/game/entity/action/usable/UsableAction.ts:287

getNPC

getNPC(player: default, provided?: IUsableActionPossibleUsing): undefined | false | default
Parameters
- player: default
- Optional provided: IUsableActionPossibleUsing
Returns undefined | false | default
- Defined in src/game/game/entity/action/usable/UsableAction.ts:486

getOrder

getOrder(using?: IUsableActionPossibleUsing): number
Parameters
- using: IUsableActionPossibleUsing = {}
Returns number
- Defined in src/game/game/entity/action/usable/UsableAction.ts:581

getSubmenu

getSubmenu(parentMenuId: string, using: IUsableActionPossibleUsing, actionExecutionContext: IUsableActionExecutionContext, fullUsabilityCheck?: boolean): undefined | default
Parameters
- parentMenuId: string
- using: IUsableActionPossibleUsing
- actionExecutionContext: IUsableActionExecutionContext
- fullUsabilityCheck: boolean = true
Returns undefined | default
- Defined in src/game/game/entity/action/usable/UsableAction.ts:585

getTranslation

getTranslation(using?: IUsableActionPossibleUsing, which?: ActionWhichTranslation, context?: UsableActionDisplayContext): undefined | default
Parameters
- Optional using: IUsableActionPossibleUsing
- which: ActionWhichTranslation = ActionTranslation.Name
- Optional context: UsableActionDisplayContext
Returns undefined | default
- Defined in src/game/game/entity/action/usable/UsableAction.ts:560

getVehicle

getVehicle(player: default, provided?: IUsableActionPossibleUsing): undefined | false | default
Parameters
- player: default
- Optional provided: IUsableActionPossibleUsing
Returns undefined | false | default
- Defined in src/game/game/entity/action/usable/UsableAction.ts:434

is

is(id?: ActionId): boolean
Parameters
- Optional id: ActionId
Returns boolean
- Defined in src/game/game/entity/action/usable/UsableAction.ts:90

isApplicable

isApplicable(player: default, provided?: IUsableActionPossibleUsing, fullUsabilityCheck?: boolean, requireItem?: boolean): provided is IUsableActionUsing<REQUIREMENTS>
Parameters
- player: default
- Optional provided: IUsableActionPossibleUsing
- fullUsabilityCheck: boolean = true
- requireItem: boolean = true
Returns provided is IUsableActionUsing<REQUIREMENTS>
- Defined in src/game/game/entity/action/usable/UsableAction.ts:234

isExecutable

isExecutable(): this is default<REQUIREMENTS, IUsableActionDefinitionExecutable<REQUIREMENTS>>
Returns this is default<REQUIREMENTS, IUsableActionDefinitionExecutable<REQUIREMENTS>>
- Defined in src/game/game/entity/action/usable/UsableAction.ts:94

isItemAction

isItemAction(predicate?: ((requirements: IUsableActionItemRequirement) => any)): boolean
Determines whether this action is an item action, using requirements.item
Parameters
- Optional predicate: ((requirements: IUsableActionItemRequirement) => any)
  - - (requirements: IUsableActionItemRequirement): any
    - Parameters
      
      requirements: IUsableActionItemRequirement
      
      Returns any
Returns boolean
- Defined in src/game/game/entity/action/usable/UsableAction.ts:572

isUsable

isUsable(player: default, provided: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext | UsableActionExecutionContext): UsableActionUsability<REQUIREMENTS>
Parameters
- player: default
- provided: IUsableActionUsing<REQUIREMENTS>
- context: IUsableActionExecutionContext | UsableActionExecutionContext
Returns UsableActionUsability<REQUIREMENTS>
- Defined in src/game/game/entity/action/usable/UsableAction.ts:178

resolveUsing

resolveUsing(player: default, using: IUsableActionUsing<REQUIREMENTS>, fillTiles?: boolean): default | IUsableActionUsing<REQUIREMENTS>
Parameters
- player: default
- using: IUsableActionUsing<REQUIREMENTS>
- fillTiles: boolean = true
Returns default | IUsableActionUsing<REQUIREMENTS>
- Defined in src/game/game/entity/action/usable/UsableAction.ts:119

resolveUsingOrUndefined

resolveUsingOrUndefined(player: default, using: IUsableActionUsing<REQUIREMENTS>, fillTiles?: boolean): undefined | IUsableActionUsing<REQUIREMENTS>
Parameters
- player: default
- using: IUsableActionUsing<REQUIREMENTS>
- Optional fillTiles: boolean
Returns undefined | IUsableActionUsing<REQUIREMENTS>
- Defined in src/game/game/entity/action/usable/UsableAction.ts:173

Class default<REQUIREMENTS, DEFINITION>

Type Parameters

REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements

DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

REQUIREMENTS extends IUsableActionRequirements<REQUIREMENTS> = IUsableActionRequirements

DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>

Parameters

requirements: REQUIREMENTS

definition: DEFINITION

Returns default<REQUIREMENTS, DEFINITION>

Properties

Readonly definition

Readonly event

id

Readonly observe

Readonly requirements

Accessors

itemRequirementObject

Returns undefined | IUsableActionItemRequirement

Methods

canUseOnMove

Returns boolean

canUseOnMoveWhenDiscovered

Returns boolean

execute

Parameters

player: default

provided: IUsableActionUsing<REQUIREMENTS>

context: IUsableActionExecutionContext | UsableActionExecutionContext

Returns boolean

getAlignment

Parameters

using: IUsableActionPossibleUsing = {}

Returns DeityReal[]

getContextualLevel

Parameters

using: IUsableActionPossibleUsing = {}

parentMenuId: string

actionExecutionContext: IUsableActionExecutionContext

Returns number

getCreature

Parameters

player: default

Optional provided: IUsableActionPossibleUsing

Returns undefined | false | default

getDoodad

Parameters

player: default

Optional provided: IUsableActionPossibleUsing

Returns undefined | false | default

getFindItemCannotUse

Returns IUsableActionNotUsable[]

getHighlightSelectors

Parameters

Optional using: IUsableActionPossibleUsing

Returns (undefined | HighlightSelector)[]

getIcon

Parameters

provided: IUsableActionPossibleUsing

context: UsableActionDisplayContext = UsableActionDisplayContext.Use

Returns undefined | IIcon

getInteractionDistance

Parameters

Optional provided: IUsableActionPossibleUsing

Returns undefined | InteractionDistance

getInternalActionType

Returns undefined | ActionType

getItem

Parameters

player: default

Optional provided: IUsableActionPossibleUsing

`Readonly` definition

`Readonly` event

`Readonly` observe

`Readonly` requirements

`Optional` provided: IUsableActionPossibleUsing

`Optional` provided: IUsableActionPossibleUsing

`Optional` using: IUsableActionPossibleUsing

`Optional` provided: IUsableActionPossibleUsing

`Optional` provided: IUsableActionPossibleUsing

`Optional` provided: IUsableActionPossibleUsing

`Optional` using: IUsableActionPossibleUsing

`Optional` context: UsableActionDisplayContext

`Optional` provided: IUsableActionPossibleUsing

`Optional` id: ActionId

`Optional` provided: IUsableActionPossibleUsing

`Optional` predicate: ((requirements: IUsableActionItemRequirement) => any)

`Optional` fillTiles: boolean