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

Type Parameters

A extends ActionArguments
E extends default = default
R = void
CU extends IActionUsable = IActionUsable
AV extends any[] = ActionArgumentTupleTypes<A>

Hierarchy

Action

Implements

IActionDescription<A, E, R, CU, AV>

Constructors

constructor

new Action<A, E, R, CU, AV>(...argumentTypes: A): Action<A, E, R, CU, AV>
Type Parameters
- A extends ActionArgumentsEntry[]
- E extends default<unknown, number, EntityReferenceTypes, unknown, E> = default<unknown, number, EntityReferenceTypes, unknown>
- R = void
- CU extends IActionUsable = IActionUsable
- AV extends any[] = ActionArgumentTupleTypes<A>
Parameters
- Rest ...argumentTypes: A
Returns Action<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/Action.ts:52

Properties

`Readonly` argumentTypes

argumentTypes: A

canUseHandler

canUseHandler: ((actionApi: IActionHandlerApi<E, CU>, ...args: AV) => CU | IActionNotUsable)

Type declaration

- (actionApi: IActionHandlerApi<E, CU>, ...args: AV): CU | IActionNotUsable
- Parameters
  - actionApi: IActionHandlerApi<E, CU>
  - Rest ...args: AV
  Returns CU | IActionNotUsable

`Optional` confirmer

confirmer?: ((actionApi: IActionConfirmerApi<E, any>, ...args: AV) => Promise<boolean>)

Type declaration

- (actionApi: IActionConfirmerApi<E, any>, ...args: AV): Promise<boolean>
- Parameters
  - actionApi: IActionConfirmerApi<E, any>
  - Rest ...args: AV
  Returns Promise<boolean>

`Optional` deities

deities?: DeityReal[]

`Optional` exampleHandler

exampleHandler?: ((actionApi: IActionExampleApi<E, CU>, ...args: AV) => IActionExample)

Type declaration

- (actionApi: IActionExampleApi<E, CU>, ...args: AV): IActionExample
- Parameters
  - actionApi: IActionExampleApi<E, CU>
  - Rest ...args: AV
  Returns IActionExample

`Readonly` flags

flags: {
0: undefined | boolean;
} = {}

Type declaration

0: undefined | boolean

handler

handler: ((actionApi: IActionHandlerApi<E, CU>, ...args: AV) => R)

Type declaration

- (actionApi: IActionHandlerApi<E, CU>, ...args: AV): R
- Parameters
  - actionApi: IActionHandlerApi<E, CU>
  - Rest ...args: AV
  Returns R

notUsableHandler

notUsableHandler: ((actionApi: IActionNotUsableHandlerApi<E, CU>, ...args: AV) => R)

Type declaration

- (actionApi: IActionNotUsableHandlerApi<E, CU>, ...args: AV): R
- Parameters
  - actionApi: IActionNotUsableHandlerApi<E, CU>
  - Rest ...args: AV
  Returns R

`Optional` preExecutionHandler

preExecutionHandler?: ((actionApi: IActionApi<E, CU>, ...args: AV) => any)

Type declaration

- (actionApi: IActionApi<E, CU>, ...args: AV): any
- Parameters
  - actionApi: IActionApi<E, CU>
  - Rest ...args: AV
  Returns any

`Readonly` usability

usability: {
    0: undefined | boolean;
    1: undefined | boolean;
    2: undefined | boolean;
    3: undefined | boolean;
    4: undefined | boolean;
} = {}

Type declaration

0: undefined | boolean
1: undefined | boolean
2: undefined | boolean
3: undefined | boolean
4: undefined | boolean

validExecutors

validExecutors: Set<EntityType>

Accessors

hasSetCanUse

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

Returns boolean
Implementation of IActionDescription.hasSetCanUse
- Defined in src/game/game/entity/action/Action.ts:59

Methods

canUse

canUse(actionApi: IActionApi<E, any>, ...args: AV): CU | IActionNotUsable
Parameters
- actionApi: IActionApi<E, any>
- Rest ...args: AV
Returns CU | IActionNotUsable
Implementation of IActionDescription.canUse
- Defined in src/game/game/entity/action/Action.ts:67
canUse(executor: E, ...args: AV): CU | IActionNotUsable
Parameters
- executor: E
- Rest ...args: AV
Returns CU | IActionNotUsable
Implementation of IActionDescription.canUse
- Defined in src/game/game/entity/action/Action.ts:68

canUseAt

canUseAt(actionExecutor: E, location?: Partial<IActionTargetAdjacent>, ...args: AV): CU | IActionNotUsable
Parameters
- actionExecutor: E
- Optional location: Partial<IActionTargetAdjacent>
- Rest ...args: AV
Returns CU | IActionNotUsable
Implementation of IActionDescription.canUseAt
- Defined in src/game/game/entity/action/Action.ts:75

canUseWhileFacing

canUseWhileFacing(actionExecutor: E, position: IVector3, direction?: East | North | West | South, ...args: AV): CU | IActionNotUsable
Parameters
- actionExecutor: E
- position: IVector3
- Optional direction: East | North | West | South
- Rest ...args: AV
Returns CU | IActionNotUsable
- Defined in src/game/game/entity/action/Action.ts:93

clone

clone(): Action<A, E, R, CU, AV>
Creates an identical clone of this action.

Returns Action<A, E, R, CU, AV>
Implementation of IActionDescription.clone
- Defined in src/game/game/entity/action/Action.ts:317

execute

execute(actionApiOrExecutor: E | IActionApi<E, any>, ...args: AV): undefined | R | Promise<R> | Promise<undefined | R>
Parameters
- actionApiOrExecutor: E | IActionApi<E, any>
- Rest ...args: AV
Returns undefined | R | Promise<R> | Promise<undefined | R>
Implementation of IActionDescription.execute
- Defined in src/game/game/entity/action/Action.ts:99

executeAt

executeAt(actionApiOrExecutor: E | IActionApi<E, any>, location: IActionTargetAdjacent, ...args: AV): Promise<undefined | R>
Parameters
- actionApiOrExecutor: E | IActionApi<E, any>
- location: IActionTargetAdjacent
- Rest ...args: AV
Returns Promise<undefined | R>
Implementation of IActionDescription.executeAt
- Defined in src/game/game/entity/action/Action.ts:113

executeConfirmer

executeConfirmer(actionApiOrExecutor: E | IActionApi<E, any>, args: AV): Promise<boolean>
Parameters
- actionApiOrExecutor: E | IActionApi<E, any>
- args: AV
Returns Promise<boolean>
Implementation of IActionDescription.executeConfirmer
- Defined in src/game/game/entity/action/Action.ts:189

executeOn

executeOn(actionApiOrExecutor: E | IActionApi<E, any>, targetEntity?: default<unknown, number, EntityReferenceTypes, unknown> | IActionTargetEntityRanged, ...args: AV): Promise<undefined | R>
Parameters
- actionApiOrExecutor: E | IActionApi<E, any>
- Optional targetEntity: default<unknown, number, EntityReferenceTypes, unknown> | IActionTargetEntityRanged
- Rest ...args: AV
Returns Promise<undefined | R>
Implementation of IActionDescription.executeOn
- Defined in src/game/game/entity/action/Action.ts:156

executeRanged

executeRanged(actionApiOrExecutor: E | IActionApi<E, any>, target: IActionTargetTileRanged, ...args: AV): Promise<undefined | R>
Parameters
- actionApiOrExecutor: E | IActionApi<E, any>
- target: IActionTargetTileRanged
- Rest ...args: AV
Returns Promise<undefined | R>
Implementation of IActionDescription.executeRanged
- Defined in src/game/game/entity/action/Action.ts:139

getExample

getExample(executor: E, ...args: AV): undefined | IActionExample
Parameters
- executor: E
- Rest ...args: AV
Returns undefined | IActionExample
Implementation of IActionDescription.getExample
- Defined in src/game/game/entity/action/Action.ts:63

hasFlag

hasFlag(flag: AllowPacketConcurrency): boolean
Checks if a flag is set
Parameters
- flag: AllowPacketConcurrency
  
  Flag to check
Returns boolean
Implementation of IActionDescription.hasFlag
- Defined in src/game/game/entity/action/Action.ts:301

setCanUse

setCanUse<T>(canUseHandler: ((actionApi: IActionHandlerApi<E, CU>, ...args: AV) => IActionNotUsable | T)): Action<A, E, R, T, ActionArgumentTupleTypes<A>>
Add a can use handler for this action.

This determines if an action is usable or not
Type Parameters
- T extends IActionUsable
Parameters
- canUseHandler: ((actionApi: IActionHandlerApi<E, CU>, ...args: AV) => IActionNotUsable | T)
  - - (actionApi: IActionHandlerApi<E, CU>, ...args: AV): IActionNotUsable | T
    - Parameters
      
      actionApi: IActionHandlerApi<E, CU>
      
      Rest ...args: AV
      
      Returns IActionNotUsable | T
Returns Action<A, E, R, T, ActionArgumentTupleTypes<A>>
- Defined in src/game/game/entity/action/Action.ts:242

setConfirmer

setConfirmer(confirmer: ((actionApi: IActionConfirmerApi<E, CU>, ...args: AV) => Promise<boolean>)): Action<A, E, R, CU, AV>
Add an asynchronous "confirmer" handler to this action.

When an entity attempts to execute an action, the confirmer is the second handler called (after the pre-execution handler). Confirmer handlers are executed on the client-side only.

Note: If you use actionApi.addItems in a pre-execution handler, a confirmation interrupt will already be shown. In that case, a confirmer is unnecessary.

Returns
false to cancel the execution of the action.
Parameters
- confirmer: ((actionApi: IActionConfirmerApi<E, CU>, ...args: AV) => Promise<boolean>)
  - - (actionApi: IActionConfirmerApi<E, CU>, ...args: AV): Promise<boolean>
    - Parameters
      
      actionApi: IActionConfirmerApi<E, CU>
      
      Rest ...args: AV
      
      Returns Promise<boolean>
Returns Action<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/Action.ts:224

setDeityDomain

setDeityDomain(...deities: DeityReal[]): Action<A, E, R, CU, AV>
Sets which deities can award runes for this action
Parameters
- Rest ...deities: DeityReal[]
Returns Action<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/Action.ts:309

setExample

setExample(exampleHandler: ((actionApi: IActionExampleApi<E, CU>, ...args: AV) => IActionExample)): Action<A, E, R, CU, AV>
Add an example to this action.
Parameters
- exampleHandler: ((actionApi: IActionExampleApi<E, CU>, ...args: AV) => IActionExample)
  - - (actionApi: IActionExampleApi<E, CU>, ...args: AV): IActionExample
    - Parameters
      
      actionApi: IActionExampleApi<E, CU>
      
      Rest ...args: AV
      
      Returns IActionExample
Returns Action<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/Action.ts:232

setFlags

setFlags(...flags: AllowPacketConcurrency[]): Action<A, E, R, CU, AV>
Sets additional flags for this action.
Parameters
- Rest ...flags: AllowPacketConcurrency[]
Returns Action<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/Action.ts:281

setHandler

setHandler<H>(handler: H): Action<A, E, ReturnType<H>, CU, ActionArgumentTupleTypes<A>>
Add a handler for this action.

Handlers are executed on both the client-side and the server-side.
Type Parameters
- H extends ((actionApi: IActionHandlerApi<E, CU>, ...args: AV) => R)
Parameters
- handler: H
Returns Action<A, E, ReturnType<H>, CU, ActionArgumentTupleTypes<A>>
- Defined in src/game/game/entity/action/Action.ts:252

setNotUsableHandler

setNotUsableHandler<H>(handler: H): Action<A, E, ReturnType<H>, CU, ActionArgumentTupleTypes<A>>
Add a handler that is called when it's executed while not being usable

Handlers are executed on both the client-side and the server-side.
Type Parameters
- H extends ((actionApi: IActionNotUsableHandlerApi<E, CU>, ...args: AV) => R)
Parameters
- handler: H
Returns Action<A, E, ReturnType<H>, CU, ActionArgumentTupleTypes<A>>
- Defined in src/game/game/entity/action/Action.ts:262

setPreExecutionHandler

setPreExecutionHandler(handler: ((actionApi: IActionApi<E, CU>, ...args: AV) => any)): Action<A, E, R, CU, AV>
Add a "pre-execution" handler to this action.

When an entity attempts to execute an action, the pre-execution handler is the first handler called. Pre-execution handlers are executed on the client-side only.

Returns
false to cancel the execution of the action.
Parameters
- handler: ((actionApi: IActionApi<E, CU>, ...args: AV) => any)
  - - (actionApi: IActionApi<E, CU>, ...args: AV): any
    - Parameters
      
      actionApi: IActionApi<E, CU>
      
      Rest ...args: AV
      
      Returns any
Returns Action<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/Action.ts:208

setUsableBy

setUsableBy<E2>(...entityTypes: E2): Action<A, EntityTypeTupleType<E2>, void, IActionUsable, ActionArgumentTupleTypes<A>>
Sets the entities that can use an action.
Type Parameters
- E2 extends EntityType[]
Parameters
- Rest ...entityTypes: E2
Returns Action<A, EntityTypeTupleType<E2>, void, IActionUsable, ActionArgumentTupleTypes<A>>
- Defined in src/game/game/entity/action/Action.ts:292

setUsableWhen

setUsableWhen(...usabilities: ActionUsability[]): Action<A, E, R, CU, AV>
Sets additional times the action can be used in.
Parameters
- Rest ...usabilities: ActionUsability[]
Returns Action<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/Action.ts:270

skipConfirmation

skipConfirmation(): Action<A, E, R, CU, AV>
Returns Action<A, E, R, CU, AV>
Implementation of IActionDescription.skipConfirmation
- Defined in src/game/game/entity/action/Action.ts:195

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

Type Parameters

A extends ActionArguments

E extends default = default

R = void

CU extends IActionUsable = IActionUsable

AV extends any[] = ActionArgumentTupleTypes<A>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

A extends ActionArgumentsEntry[]

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

R = void

CU extends IActionUsable = IActionUsable

AV extends any[] = ActionArgumentTupleTypes<A>

Parameters

Rest ...argumentTypes: A

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

Properties

Readonly argumentTypes

canUseHandler

Type declaration

Parameters

actionApi: IActionHandlerApi<E, CU>

Rest ...args: AV

Returns CU | IActionNotUsable

Optional confirmer

Type declaration

Parameters

actionApi: IActionConfirmerApi<E, any>

Rest ...args: AV

Returns Promise<boolean>

Optional deities

Optional exampleHandler

Type declaration

Parameters

actionApi: IActionExampleApi<E, CU>

Rest ...args: AV

Returns IActionExample

Readonly flags

Type declaration

0: undefined | boolean

handler

Type declaration

Parameters

actionApi: IActionHandlerApi<E, CU>

Rest ...args: AV

Returns R

notUsableHandler

Type declaration

Parameters

actionApi: IActionNotUsableHandlerApi<E, CU>

Rest ...args: AV

Returns R

Optional preExecutionHandler

Type declaration

Parameters

actionApi: IActionApi<E, CU>

Rest ...args: AV

Returns any

Readonly usability

Type declaration

0: undefined | boolean

1: undefined | boolean

2: undefined | boolean

3: undefined | boolean

4: undefined | boolean

validExecutors

Accessors

hasSetCanUse

Returns boolean

Methods

canUse

`Rest` ...argumentTypes: A

`Readonly` argumentTypes

`Rest` ...args: AV

`Optional` confirmer

`Rest` ...args: AV

`Optional` deities

`Optional` exampleHandler

`Rest` ...args: AV

`Readonly` flags

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` preExecutionHandler

`Rest` ...args: AV

`Readonly` usability

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` location: Partial<IActionTargetAdjacent>

`Rest` ...args: AV

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

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` targetEntity: default<unknown, number, EntityReferenceTypes, unknown> | IActionTargetEntityRanged

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV