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

Type Parameters

A extends (ActionArgument | ActionArgument[])[]
E extends default = default
R = void
CU extends IActionUsable = IActionUsable
AV extends any[] = ActionArgumentTupleTypes<A>

Hierarchy

Action

Implements

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

Index

Constructors

constructor

new Action<A, E, R, CU, AV>(...argumentTypes: A): Action<A, E, R, CU, AV>
Type Parameters
- A extends (ActionArgument | ActionArgument[])[]
- E extends default<unknown, number, unknown, unknown> = default<unknown, number, unknown, 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:39

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` 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

`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:46

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:54
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:55

canUseWhileFacing

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

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

execute

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

executeConfirmer

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

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

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

setCanUse

setCanUse<T>(canUseHandler: ((actionApi: IActionHandlerApi<E, CU>, ...args: AV) => T | IActionNotUsable)): 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) => T | IActionNotUsable)
  - - (actionApi: IActionHandlerApi<E, CU>, ...args: AV): T | IActionNotUsable
    - Parameters
      
      actionApi: IActionHandlerApi<E, CU>
      
      Rest ...args: AV
      
      Returns T | IActionNotUsable
Returns Action<A, E, R, T, ActionArgumentTupleTypes<A>>
- Defined in src/game/game/entity/action/Action.ts:132

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

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

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

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

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

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

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

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

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

Type Parameters

A extends (ActionArgument | ActionArgument[])[]

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 (ActionArgument | ActionArgument[])[]

E extends default<unknown, number, unknown, unknown> = default<unknown, number, unknown, 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 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

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

Parameters

actionApi: IActionApi<E, any>

Rest ...args: AV

Returns CU | IActionNotUsable

Parameters

executor: E

Rest ...args: AV

`Rest` ...argumentTypes: A

`Readonly` argumentTypes

`Rest` ...args: AV

`Optional` confirmer

`Rest` ...args: AV

`Optional` exampleHandler

`Rest` ...args: AV

`Readonly` flags

`Rest` ...args: AV

`Optional` preExecutionHandler

`Rest` ...args: AV

`Readonly` usability

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` argumentTypes: ActionArgument[]

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...args: AV

`Rest` ...flags: AllowPacketConcurrency[]