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 = IUsableActionRequirements
- DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>
Parameters
- requirements: REQUIREMENTS
- definition: DEFINITION
Returns default<REQUIREMENTS, DEFINITION>
Overrides Host.constructor
- Defined in src/game/game/entity/action/usable/UsableAction.ts:65

Properties

`Readonly` definition

definition: DEFINITION

`Readonly` event

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

id

id: ActionId

`Readonly` requirements

requirements: REQUIREMENTS

Methods

canUseOnMove

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

canUseOnMoveWhenDiscovered

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

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:77

getContextualLevel

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

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:368

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:343

getFindItemCannotUse

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

getHighlightSelectors

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

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:418

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:240

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:393

getOrder

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

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:466

isApplicable

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

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:73

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:131

resolveUsing

resolveUsing(player: default, using: IUsableActionUsing<REQUIREMENTS>): UiActionCannotUseRequiresCreature | UiActionCannotUseRequiresDoodad | UiActionCannotUseRequiresItem | UiActionCannotUseRequiresNPC | IUsableActionUsing<REQUIREMENTS>
Parameters
- player: default
- using: IUsableActionUsing<REQUIREMENTS>
Returns UiActionCannotUseRequiresCreature | UiActionCannotUseRequiresDoodad | UiActionCannotUseRequiresItem | UiActionCannotUseRequiresNPC | IUsableActionUsing<REQUIREMENTS>
- Defined in src/game/game/entity/action/usable/UsableAction.ts:96

resolveUsingOrUndefined

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

Class default<REQUIREMENTS, DEFINITION>

Type Parameters

REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements

DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements

DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>

Parameters

requirements: REQUIREMENTS

definition: DEFINITION

Returns default<REQUIREMENTS, DEFINITION>

Properties

Readonly definition

Readonly event

id

Readonly requirements

Methods

canUseOnMove

Returns boolean

canUseOnMoveWhenDiscovered

Returns boolean

execute

Parameters

player: default

provided: IUsableActionUsing<REQUIREMENTS>

context: IUsableActionExecutionContext | UsableActionExecutionContext

Returns boolean

getContextualLevel

Parameters

using: IUsableActionPossibleUsing = {}

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 HighlightSelector[]

getIcon

Parameters

provided: IUsableActionPossibleUsing

context: UsableActionDisplayContext = UsableActionDisplayContext.Use

Returns undefined | IIcon

getItem

Parameters

player: default

Optional provided: IUsableActionPossibleUsing

fullUsabilityCheck: boolean = true

Returns undefined | false | default

getNPC

Parameters

player: default

Optional provided: IUsableActionPossibleUsing

Returns undefined | false | default

getOrder

Parameters

using: IUsableActionPossibleUsing = {}

Returns number

getTranslation

Parameters

Optional using: IUsableActionPossibleUsing

which: ActionWhichTranslation = ActionTranslation.Name

Optional context: UsableActionDisplayContext

Returns undefined | default

`Readonly` definition

`Readonly` event

`Readonly` requirements

`Optional` provided: IUsableActionPossibleUsing

`Optional` provided: IUsableActionPossibleUsing

`Optional` using: IUsableActionPossibleUsing

`Optional` provided: IUsableActionPossibleUsing

`Optional` provided: IUsableActionPossibleUsing

`Optional` using: IUsableActionPossibleUsing

`Optional` context: UsableActionDisplayContext

`Optional` provided: IUsableActionPossibleUsing