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

Type Parameters

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

Hierarchy

IModdable
- IActionDescription

Implemented by

Action

Index

Properties

argumentTypes flags hasSetCanUse modIndex? type? usability validExecutors

Methods

canUse canUseHandler clone confirmer? exampleHandler? execute executeConfirmer getExample handler hasFlag preExecutionHandler? skipConfirmation

Properties

argumentTypes

argumentTypes: A

flags

flags: {
0: undefined | boolean;
}

Type declaration

0: undefined | boolean

`Readonly` hasSetCanUse

hasSetCanUse: boolean

Check if the action has setup CanUse logic

`Optional` modIndex

modIndex?: number

Do not provide or modify this value, only reference it. This is set by the modding system during the process of registration.

`Optional` type

type?: number

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>

Methods

canUse

canUse(executor: E, ...args: AV): CU | IActionNotUsable
Parameters
- executor: E
- Rest ...args: AV
Returns CU | IActionNotUsable
- Defined in src/game/game/entity/action/IAction.ts:259

canUseHandler

canUseHandler(actionApi: IActionHandlerApi<E, CU>, ...args: AV): CU | IActionNotUsable
Called internally before execute
Parameters
- actionApi: IActionHandlerApi<E, CU>
- Rest ...args: AV
Returns CU | IActionNotUsable
- Defined in src/game/game/entity/action/IAction.ts:269

clone

clone(): IActionDescription<A, E, R, CU, AV>
Returns IActionDescription<A, E, R, CU, AV>
- Defined in src/game/game/entity/action/IAction.ts:288

`Optional` confirmer

confirmer(actionApi: IActionConfirmerApi<E, CU>, ...args: AV): Promise<boolean>
Called internally during execute
Parameters
- actionApi: IActionConfirmerApi<E, CU>
- Rest ...args: AV
Returns Promise<boolean>
- Defined in src/game/game/entity/action/IAction.ts:279

`Optional` exampleHandler

exampleHandler(actionApi: IActionExampleApi<E, CU>, ...args: AV): IActionExample
Called internally before execute
Parameters
- actionApi: IActionExampleApi<E, CU>
- Rest ...args: AV
Returns IActionExample
- Defined in src/game/game/entity/action/IAction.ts:284

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/IAction.ts:249

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>
- Defined in src/game/game/entity/action/IAction.ts:250

getExample

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

handler

handler(actionApi: IActionHandlerApi<E, CU>, ...args: AV): R
Called internally during execute
Parameters
- actionApi: IActionHandlerApi<E, CU>
- Rest ...args: AV
Returns R
- Defined in src/game/game/entity/action/IAction.ts:274

hasFlag

hasFlag(flag: AllowPacketConcurrency): boolean
Parameters
- flag: AllowPacketConcurrency
Returns boolean
- Defined in src/game/game/entity/action/IAction.ts:248

`Optional` preExecutionHandler

preExecutionHandler(actionApi: IActionApi<E, CU>, ...args: AV): any
Called internally during execute
Parameters
- actionApi: IActionApi<E, CU>
- Rest ...args: AV
Returns any
- Defined in src/game/game/entity/action/IAction.ts:264

skipConfirmation

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

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

Type Parameters

A extends (ActionArgument | ActionArgument[])[] = (ActionArgument | ActionArgument[])[]

E extends default = default

R = void

CU extends IActionUsable = IActionUsable

AV extends any[] = ActionArgumentTupleTypes<A>

Hierarchy

Implemented by

Index

Properties

Methods

Properties

argumentTypes

flags

Type declaration

0: undefined | boolean

Readonly hasSetCanUse

Optional modIndex

Optional type

usability

Type declaration

0: undefined | boolean

1: undefined | boolean

2: undefined | boolean

3: undefined | boolean

4: undefined | boolean

validExecutors

Methods

canUse

Parameters

executor: E

Rest ...args: AV

Returns CU | IActionNotUsable

canUseHandler

Parameters

actionApi: IActionHandlerApi<E, CU>

Rest ...args: AV

Returns CU | IActionNotUsable

clone

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

Optional confirmer

Parameters

actionApi: IActionConfirmerApi<E, CU>

Rest ...args: AV

Returns Promise<boolean>

Optional exampleHandler

Parameters

actionApi: IActionExampleApi<E, CU>

Rest ...args: AV

Returns IActionExample

execute

Parameters

actionApiOrExecutor: E | IActionApi<E, CU>

Rest ...args: AV

Returns R | Promise<R>

executeConfirmer

Parameters

actionApiOrExecutor: E | IActionApi<E, any>

args: AV

Optional argumentTypes: ActionArgument[]

Returns Promise<boolean>

getExample

Parameters

executor: E

Rest ...args: AV

Returns undefined | IActionExample

handler

Parameters

actionApi: IActionHandlerApi<E, CU>

Rest ...args: AV

Returns R

hasFlag

Parameters

flag: AllowPacketConcurrency

Returns boolean

Optional preExecutionHandler

Parameters

actionApi: IActionApi<E, CU>

Rest ...args: AV

`Readonly` hasSetCanUse

`Optional` modIndex

`Optional` type

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` confirmer

`Rest` ...args: AV

`Optional` exampleHandler

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` argumentTypes: ActionArgument[]

`Rest` ...args: AV

`Rest` ...args: AV

`Optional` preExecutionHandler

`Rest` ...args: AV