Class default<A, E, R, CU, AV>

Type Parameters

A extends ActionArguments
E extends default
R
CU extends IActionUsable
AV extends any[]

Hierarchy

Host<ActionExecutorEvents>
- default

Implements

IActionApi<E, CU>
IActionConfirmerApi<E, CU>

Constructors

constructor

new default<A, E, R, CU, AV>(action?: IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>, type?: undefined | number): default<A, E, R, CU, AV>
Type Parameters
- A extends ActionArgumentsEntry[]
- E extends default<unknown, number, EntityReferenceTypes, unknown, E>
- R
- CU extends IActionUsable
- AV extends any[]
Parameters
- Optional action: IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>
- type: undefined | number = action.type
Returns default<A, E, R, CU, AV>
Overrides EventEmitter.Host<ActionExecutorEvents>.constructor
- Defined in src/game/game/entity/action/ActionExecutor.ts:203

Properties

`Readonly` event

event: IEventEmitter<default<A, E, R, CU, AV>, ActionExecutorEvents>

`Optional` targetTile

targetTile?: default

`Readonly` type

type: ActionType

use

use: CU

Result of a successful canUse check.

Accessors

actionStack

get actionStack(): ActionType[]
Returns ActionType[]
Implementation of IActionConfirmerApi.actionStack
- Defined in src/game/game/entity/action/ActionExecutor.ts:155

callingAction

get callingAction(): ActionType
Returns ActionType
Implementation of IActionConfirmerApi.callingAction
- Defined in src/game/game/entity/action/ActionExecutor.ts:159

description

get description(): IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>
Returns IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>
- Defined in src/game/game/entity/action/ActionExecutor.ts:217

executor

get executor(): E
Returns E
Implementation of IActionConfirmerApi.executor
- Defined in src/game/game/entity/action/ActionExecutor.ts:147

hasSetCanUse

get hasSetCanUse(): boolean
Check if the action has setup CanUse logic

Returns boolean
Implementation of IActionConfirmerApi.hasSetCanUse
- Defined in src/game/game/entity/action/ActionExecutor.ts:166

Methods

addItems

addItems(...addItems: (undefined | default)[]): default<A, E, R, CU, AV>
The items passed to this method will be registered as items potentially to be damaged when the action completes.
Parameters
- Rest ...addItems: (undefined | default)[]
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.addItems
- Defined in src/game/game/entity/action/ActionExecutor.ts:782

addSkillGains

addSkillGains(...skills: SkillGain[]): default<A, E, R, CU, AV>
Parameters
- Rest ...skills: SkillGain[]
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.addSkillGains
- Defined in src/game/game/entity/action/ActionExecutor.ts:707
addSkillGains(skill: SkillType, amount?: number, actionTier?: number, bypass?: true, times?: number): default<A, E, R, CU, AV>
Parameters
- skill: SkillType
- Optional amount: number
- Optional actionTier: number
- Optional bypass: true
- Optional times: number
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.addSkillGains
- Defined in src/game/game/entity/action/ActionExecutor.ts:708

canProtectedItemBeUsed

canProtectedItemBeUsed(items: IProtectedItems): true | IActionNotUsable
Checks to see if a protected item can be used
Parameters
- items: IProtectedItems
Returns true | IActionNotUsable
Implementation of IActionConfirmerApi.canProtectedItemBeUsed
- Defined in src/game/game/entity/action/ActionExecutor.ts:788

canUse

canUse(): CU | IActionNotUsable
Check if an action can be used. When used within an action, the result will automatically be processed. So it will send a message to the executor / check for mobs depending on the result.

Returns CU | IActionNotUsable
Implementation of IActionConfirmerApi.canUse
- Defined in src/game/game/entity/action/ActionExecutor.ts:367
canUse(actionApi: IActionApi<E, CU>, ...args: AV): CU | IActionNotUsable
Parameters
- actionApi: IActionApi<E, CU>
- Rest ...args: AV
Returns CU | IActionNotUsable
Implementation of IActionApi.canUse
- Defined in src/game/game/entity/action/ActionExecutor.ts:368
canUse(executor: E, ...args: AV): CU | IActionNotUsable
Parameters
- executor: E
- Rest ...args: AV
Returns CU | IActionNotUsable
Implementation of IActionApi.canUse
- Defined in src/game/game/entity/action/ActionExecutor.ts:369

canUseWhileFacing

canUseWhileFacing(executor: E, position: IVector3, direction?: East | North | West | South, ...args: AV): CU | IActionNotUsable
Alternate version of canUse that allows you to specify the facing point. Use with caution as this probably won't work for some actions
Parameters
- executor: E
- position: IVector3
- Optional direction: East | North | West | South
- Rest ...args: AV
Returns CU | IActionNotUsable
- Defined in src/game/game/entity/action/ActionExecutor.ts:449

confirmItemsBroken

confirmItemsBroken(executor: E): Promise<boolean>
Parameters
- executor: E
Returns Promise<boolean>
- Defined in src/game/game/entity/action/ActionExecutor.ts:853

execute

execute(actionApiOrExecutor: E | IActionApi<E, CU>, ...args: AV): PromiseOr<undefined | R>
Parameters
- actionApiOrExecutor: E | IActionApi<E, CU>
- Rest ...args: AV
Returns PromiseOr<undefined | R>
- Defined in src/game/game/entity/action/ActionExecutor.ts:493

executeConfirmer

executeConfirmer(actionApiOrExecutor: E | IActionApi<E, CU>, args: AV): Promise<boolean>
Parameters
- actionApiOrExecutor: E | IActionApi<E, CU>
- args: AV
Returns Promise<boolean>
- Defined in src/game/game/entity/action/ActionExecutor.ts:550

getContext

getContext(): default
Returns default
- Defined in src/game/game/entity/action/ActionExecutor.ts:626

getExample

getExample(executor: E, ...args: AV): undefined | IActionExample
Parameters
- executor: E
- Rest ...args: AV
Returns undefined | IActionExample
- Defined in src/game/game/entity/action/ActionExecutor.ts:339

getItems

getItems(): readonly default[]
Returns the items registered for this action via addItems.

Returns readonly default[]
Implementation of IActionConfirmerApi.getItems
- Defined in src/game/game/entity/action/ActionExecutor.ts:824

`Protected` giveRune

giveRune(human: default<unknown, number, NPC | Player>): void
Parameters
- human: default<unknown, number, NPC | Player>
Returns void
- Defined in src/game/game/entity/action/ActionExecutor.ts:1026

isArgumentType

isArgumentType<AA>(argument: any, index: number, argumentType: AA): argument is IActionArgumentTypeMap[AA]
Type Parameters
- AA extends ActionArgument
Parameters
- argument: any
- index: number
- argumentType: AA
Returns argument is IActionArgumentTypeMap[AA]
Implementation of IActionConfirmerApi.isArgumentType
- Defined in src/game/game/entity/action/ActionExecutor.ts:596

isCreatureBlocking

isCreatureBlocking(tile: default): boolean
Check if a creature on a tile and blocking the execution of the action

Returns
When checking before the action is being executed: true if a creature is on a tile and that creature is not hidden, false otherwise

When checking when the action is being execute true if a creature is on a tile, false otherwise
Parameters
- tile: default
Returns boolean
Implementation of IActionConfirmerApi.isCreatureBlocking
- Defined in src/game/game/entity/action/ActionExecutor.ts:324

isTileBlocked

isTileBlocked(tile: default, ...blockFlags: BlockFlag[]): boolean
Checks if stuff is blocking the tile
Parameters
- tile: default
- Rest ...blockFlags: BlockFlag[]
Returns boolean
Implementation of IActionConfirmerApi.isTileBlocked
- Defined in src/game/game/entity/action/ActionExecutor.ts:229

prompt

prompt<PROMPT>(prompt: PROMPT, ...args: PromptDescriptionArgs<PROMPT>): Promise<boolean>
Prompts the user about something
Type Parameters
- PROMPT extends IPromptDescriptionBase<any[], PROMPT>
Parameters
- prompt: PROMPT
- Rest ...args: PromptDescriptionArgs<PROMPT>
Returns Promise<boolean>
Implementation of IActionConfirmerApi.prompt
- Defined in src/game/game/entity/action/ActionExecutor.ts:582

removeItems

removeItems(...items: (undefined | default)[]): default<A, E, R, CU, AV>
Removes all items added via addItems
Parameters
- Rest ...items: (undefined | default)[]
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.removeItems
- Defined in src/game/game/entity/action/ActionExecutor.ts:828

setContext

setContext(tool?: default | default, target?: default | default | ArrayOr<default<unknown, number, EntityReferenceTypes, unknown>>, details?: Record<string, TranslationArg>): default<A, E, R, CU, AV>
Sets the contextual tool & target for an action. Exclusively used for translations atm
Parameters
- Optional tool: default | default
- Optional target: default | default | ArrayOr<default<unknown, number, EntityReferenceTypes, unknown>>
- Optional details: Record<string, TranslationArg>
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setContext
- Defined in src/game/game/entity/action/ActionExecutor.ts:617

setDelay

setDelay(delay: number, replace?: boolean): default<A, E, R, CU, AV>
Parameters
- delay: number
- Optional replace: boolean
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setDelay
- Defined in src/game/game/entity/action/ActionExecutor.ts:630

setItemsUsed

setItemsUsed(used?: boolean): default<A, E, R, CU, AV>
Parameters
- used: boolean = true
Returns default<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/ActionExecutor.ts:848

setMilestone

setMilestone(milestone: Milestone, data?: number): default<A, E, R, CU, AV>
Parameters
- milestone: Milestone
- Optional data: number
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setMilestone
- Defined in src/game/game/entity/action/ActionExecutor.ts:742

setParticle

setParticle(color: IRGB, inFront?: boolean): default<A, E, R, CU, AV>
Parameters
- color: IRGB
- Optional inFront: boolean
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setParticle
- Defined in src/game/game/entity/action/ActionExecutor.ts:761
setParticle(color: IRGB, count?: number, inFront?: boolean): default<A, E, R, CU, AV>
Parameters
- color: IRGB
- Optional count: number
- Optional inFront: boolean
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setParticle
- Defined in src/game/game/entity/action/ActionExecutor.ts:762
setParticle(particle: IActionParticle): default<A, E, R, CU, AV>
Parameters
- particle: IActionParticle
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setParticle
- Defined in src/game/game/entity/action/ActionExecutor.ts:763

setPassTurn

setPassTurn(turnType?: TurnTypeFlag): default<A, E, R, CU, AV>
Parameters
- Optional turnType: TurnTypeFlag
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setPassTurn
- Defined in src/game/game/entity/action/ActionExecutor.ts:636

setRuneChance

setRuneChance(chanceOrDeity: undefined | number | DeityReal[], chance?: number): default<A, E, R, CU, AV>
Sets the chance that this action will create a rune item in the player's inventory.
Parameters
- chanceOrDeity: undefined | number | DeityReal[]
- Optional chance: number
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setRuneChance
- Defined in src/game/game/entity/action/ActionExecutor.ts:667

setSilent

setSilent(silent?: boolean): default<A, E, R, CU, AV>
Parameters
- silent: boolean = true
Returns default<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/ActionExecutor.ts:889

setSoundEffect

setSoundEffect(soundEffect: IActionSoundEffect): default<A, E, R, CU, AV>
Parameters
- soundEffect: IActionSoundEffect
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setSoundEffect
- Defined in src/game/game/entity/action/ActionExecutor.ts:747
setSoundEffect(type: SfxType, inFront?: boolean): default<A, E, R, CU, AV>
Parameters
- type: SfxType
- Optional inFront: boolean
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setSoundEffect
- Defined in src/game/game/entity/action/ActionExecutor.ts:748

setStaminaReduction

setStaminaReduction(reduction?: SkillType, actionTier?: number): default<A, E, R, CU, AV>
Parameters
- Optional reduction: SkillType
- Optional actionTier: number
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setStaminaReduction
- Defined in src/game/game/entity/action/ActionExecutor.ts:662

setUpdateRender

setUpdateRender(): default<A, E, R, CU, AV>
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setUpdateRender
- Defined in src/game/game/entity/action/ActionExecutor.ts:647

setUpdateTablesAndWeight

setUpdateTablesAndWeight(): default<A, E, R, CU, AV>
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setUpdateTablesAndWeight
- Defined in src/game/game/entity/action/ActionExecutor.ts:652

setUpdateView

setUpdateView(updateFov?: boolean): default<A, E, R, CU, AV>
Parameters
- updateFov: boolean = false
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setUpdateView
- Defined in src/game/game/entity/action/ActionExecutor.ts:642

setUpdateWeight

setUpdateWeight(): default<A, E, R, CU, AV>
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setUpdateWeight
- Defined in src/game/game/entity/action/ActionExecutor.ts:657

skipConfirmation

skipConfirmation(): default<A, E, R, CU, AV>
Returns default<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/ActionExecutor.ts:221

`Static` executeMultiplayer

executeMultiplayer(packet: default, executor?: undefined | default<unknown, number, EntityReferenceTypes, unknown>, nonMpActionExecutor?: default<(ActionArgument | ActionArgument[])[], default<unknown, number, EntityReferenceTypes, unknown>, any, any, any[]>): unknown
Parameters
- packet: default
- executor: undefined | default<unknown, number, EntityReferenceTypes, unknown> = packet.entity
- Optional nonMpActionExecutor: default<(ActionArgument | ActionArgument[])[], default<unknown, number, EntityReferenceTypes, unknown>, any, any, any[]>
Returns unknown
- Defined in src/game/game/entity/action/ActionExecutor.ts:89

`Static` get

get<D>(action: D): D extends IActionDescription<A, E, R, CU, AV> ? default<A, E, R, CU, AV> : never
Gets an action by its description. If you're using the Action class for constructing the descriptions, just pass the action instance.

Note: Prefer IActionApi.get if you're calling this from within another action.
Type Parameters
- D extends IActionDescription<ActionArguments, default<unknown, number, EntityReferenceTypes, unknown>, any, IActionUsable, any[], D>
Parameters
- action: D
Returns D extends IActionDescription<A, E, R, CU, AV> ? default<A, E, R, CU, AV> : never
- Defined in src/game/game/entity/action/ActionExecutor.ts:78

Class default<A, E, R, CU, AV>

Type Parameters

A extends ActionArguments

E extends default

R

CU extends IActionUsable

AV extends any[]

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

A extends ActionArgumentsEntry[]

E extends default<unknown, number, EntityReferenceTypes, unknown, E>

R

CU extends IActionUsable

AV extends any[]

Parameters

Optional action: IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>

type: undefined | number = action.type

Returns default<A, E, R, CU, AV>

Properties

Readonly event

Optional targetTile

Readonly type

use

Accessors

actionStack

Returns ActionType[]

callingAction

Returns ActionType

description

Returns IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>

executor

Returns E

hasSetCanUse

Returns boolean

Methods

addItems

Parameters

Rest ...addItems: (undefined | default)[]

Returns default<A, E, R, CU, AV>

addSkillGains

Parameters

Rest ...skills: SkillGain[]

Returns default<A, E, R, CU, AV>

Parameters

skill: SkillType

Optional amount: number

Optional actionTier: number

Optional bypass: true

Optional times: number

Returns default<A, E, R, CU, AV>

canProtectedItemBeUsed

Parameters

items: IProtectedItems

Returns true | IActionNotUsable

canUse

Returns CU | IActionNotUsable

Parameters

actionApi: IActionApi<E, CU>

Rest ...args: AV

Returns CU | IActionNotUsable

Parameters

executor: E

Rest ...args: AV

Returns CU | IActionNotUsable

canUseWhileFacing

Parameters

executor: E

position: IVector3

Optional direction: East | North | West | South

Rest ...args: AV

Returns CU | IActionNotUsable

confirmItemsBroken

`Optional` action: IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>

`Readonly` event

`Optional` targetTile

`Readonly` type

`Rest` ...addItems: (undefined | default)[]

`Rest` ...skills: SkillGain[]

`Optional` amount: number

`Optional` actionTier: number

`Optional` bypass: true

`Optional` times: number

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` direction: East | North | West | South

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Protected` giveRune

`Rest` ...blockFlags: BlockFlag[]

`Rest` ...args: PromptDescriptionArgs<PROMPT>

`Rest` ...items: (undefined | default)[]

`Optional` tool: default | default

`Optional` target: default | default | ArrayOr<default<unknown, number, EntityReferenceTypes, unknown>>

`Optional` details: Record<string, TranslationArg>

`Optional` replace: boolean