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

Type Parameters

A extends (ActionArgument | ActionArgument[])[]
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 (ActionArgument | ActionArgument[])[]
- E extends default<unknown, number, unknown, unknown>
- R
- CU extends IActionUsable
- AV extends any[]
Parameters
- Optional action: IActionDescription<A, E, R, CU, ActionArgumentTupleTypes<A>>
- type: undefined | number = ...
Returns default<A, E, R, CU, AV>
Overrides Host.constructor
- Defined in src/game/game/entity/action/ActionExecutor.ts:186

Properties

`Readonly` event

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

`Readonly` type

type: ActionType

Accessors

actionStack

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

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

executor

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

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

lastAction

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

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

addSkillGains

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

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

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:261
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:262
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:263

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
- direction: East | North | West | South
- Rest ...args: AV
Returns CU | IActionNotUsable
- Defined in src/game/game/entity/action/ActionExecutor.ts:327

confirmItemsBroken

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

execute

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

executeConfirmer

executeConfirmer(actionApiOrExecutor: E | IActionApi<E, CU>, args: AV, argumentTypes?: ActionArgument[]): Promise<boolean>
Parameters
- actionApiOrExecutor: E | IActionApi<E, CU>
- args: AV
- Optional argumentTypes: ActionArgument[]
Returns Promise<boolean>
- Defined in src/game/game/entity/action/ActionExecutor.ts:423

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

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

`Protected` handleReputationChange

handleReputationChange(human: default<number>): void
Parameters
- human: default<number>
Returns void
- Defined in src/game/game/entity/action/ActionExecutor.ts:789

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

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

prompt

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

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

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

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

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

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:573
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:574
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:575

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

setReputationChange

setReputationChange(amount: number): default<A, E, R, CU, AV>
Parameters
- amount: number
Returns default<A, E, R, CU, AV>
Implementation of IActionConfirmerApi.setReputationChange
- Defined in src/game/game/entity/action/ActionExecutor.ts:518

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:559
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:560

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

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

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

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

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

skipConfirmation

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

`Static` executeMultiplayer

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

`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 AnyActionDescription
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:68

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

Type Parameters

A extends (ActionArgument | ActionArgument[])[]

E extends default

R

CU extends IActionUsable

AV extends any[]

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

A extends (ActionArgument | ActionArgument[])[]

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

R

CU extends IActionUsable

AV extends any[]

Parameters

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

type: undefined | number = ...

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

Properties

Readonly event

Readonly type

Accessors

actionStack

Returns ActionType[]

description

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

executor

Returns E

hasSetCanUse

Returns boolean

lastAction

Returns ActionType

Methods

addItems

Parameters

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

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

addSkillGains

Parameters

Rest ...skills: [SkillType, number?, number?, true?][]

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

Parameters

skill: SkillType

Optional amount: number

Optional actionTier: number

Optional bypass: true

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

direction: East | North | West | South

Rest ...args: AV

Returns CU | IActionNotUsable

confirmItemsBroken

Parameters

executor: E

Returns Promise<boolean>

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

`Readonly` event

`Readonly` type

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

`Rest` ...skills: [SkillType, number?, number?, true?][]

`Optional` amount: number

`Optional` actionTier: number

`Optional` bypass: true

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` argumentTypes: ActionArgument[]

`Rest` ...args: AV

`Protected` handleReputationChange

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

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

`Optional` replace: boolean

`Optional` data: number

`Optional` inFront: boolean

`Optional` count: number

`Optional` inFront: boolean