Interface IActionConfirmerApi<E, CU>

Type Parameters

E extends default = default
CU extends IActionUsable = IActionUsable

Hierarchy

IActionApi<E, CU>
- IActionConfirmerApi

Implemented by

default

Properties

`Readonly` actionStack

actionStack: readonly ActionType[]

`Readonly` executor

executor: E

`Readonly` hasSetCanUse

hasSetCanUse: boolean

`Readonly` lastAction

lastAction: ActionType

`Readonly` type

type: ActionType

Methods

addItems

addItems(...items: (undefined | default)[]): IActionConfirmerApi<E, CU>
The items passed to this method will be registered as items potentially to be damaged when the action completes.
Parameters
- Rest ...items: (undefined | default)[]
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.addItems
- Defined in src/game/game/entity/action/IAction.ts:354

addSkillGains

addSkillGains(...skills: [skill: SkillType, multiplier?: number, actionTier?: number, bypass?: true][]): IActionConfirmerApi<E, CU>
Parameters
- Rest ...skills: [skill: SkillType, multiplier?: number, actionTier?: number, bypass?: true][]
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.addSkillGains
- Defined in src/game/game/entity/action/IAction.ts:342
addSkillGains(skill: SkillType, multiplier?: number, actionTier?: number, bypass?: true): IActionConfirmerApi<E, CU>
Parameters
- skill: SkillType
- Optional multiplier: number
- Optional actionTier: number
- Optional bypass: true
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.addSkillGains
- Defined in src/game/game/entity/action/IAction.ts:343

canProtectedItemBeUsed

canProtectedItemBeUsed(items: IProtectedItems): true | IActionNotUsable
Checks to see if a protected item can be used
Parameters
- items: IProtectedItems
Returns true | IActionNotUsable
Inherited from IActionApi.canProtectedItemBeUsed
- Defined in src/game/game/entity/action/IAction.ts:370

canUse

canUse(): IActionNotUsable | CU
Returns IActionNotUsable | CU
Inherited from IActionApi.canUse
- Defined in src/game/game/entity/action/IAction.ts:322

getItems

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

Returns readonly default[]
Inherited from IActionApi.getItems
- Defined in src/game/game/entity/action/IAction.ts:358

isArgumentType

isArgumentType<A>(argument: any, index: number, argumentType: A): argument is IActionArgumentTypeMap[A]
Type Parameters
- A extends ActionArgument
Parameters
- argument: any
- index: number
- argumentType: A
Returns argument is IActionArgumentTypeMap[A]
Inherited from IActionApi.isArgumentType
- Defined in src/game/game/entity/action/IAction.ts:318

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
Inherited from IActionApi.isCreatureBlocking
- Defined in src/game/game/entity/action/IAction.ts:333

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

removeItems

removeItems(): IActionConfirmerApi<E, CU>
Removes all items added via addItems

Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.removeItems
- Defined in src/game/game/entity/action/IAction.ts:362
removeItems(...items: (undefined | default)[]): IActionConfirmerApi<E, CU>
Removes specific items added by addItems
Parameters
- Rest ...items: (undefined | default)[]
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.removeItems
- Defined in src/game/game/entity/action/IAction.ts:366

setDelay

setDelay(delay: number, replace?: boolean): IActionConfirmerApi<E, CU>
Parameters
- delay: number
- Optional replace: boolean
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setDelay
- Defined in src/game/game/entity/action/IAction.ts:335

setMilestone

setMilestone(milestone: Milestone, data?: number): IActionConfirmerApi<E, CU>
Parameters
- milestone: Milestone
- Optional data: number
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setMilestone
- Defined in src/game/game/entity/action/IAction.ts:347

setParticle

setParticle(color: IRGB, count?: number, inFront?: boolean): IActionConfirmerApi<E, CU>
Parameters
- color: IRGB
- Optional count: number
- Optional inFront: boolean
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setParticle
- Defined in src/game/game/entity/action/IAction.ts:348
setParticle(color: IRGB, inFront?: boolean): IActionConfirmerApi<E, CU>
Parameters
- color: IRGB
- Optional inFront: boolean
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setParticle
- Defined in src/game/game/entity/action/IAction.ts:349
setParticle(particle: IActionParticle): IActionConfirmerApi<E, CU>
Parameters
- particle: IActionParticle
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setParticle
- Defined in src/game/game/entity/action/IAction.ts:350

setPassTurn

setPassTurn(turnType?: TurnTypeFlag): IActionConfirmerApi<E, CU>
Parameters
- Optional turnType: TurnTypeFlag
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setPassTurn
- Defined in src/game/game/entity/action/IAction.ts:336

setReputationChange

setReputationChange(amount: number): IActionConfirmerApi<E, CU>
Parameters
- amount: number
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setReputationChange
- Defined in src/game/game/entity/action/IAction.ts:346

setSoundEffect

setSoundEffect(soundEffect: IActionSoundEffect): IActionConfirmerApi<E, CU>
Parameters
- soundEffect: IActionSoundEffect
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setSoundEffect
- Defined in src/game/game/entity/action/IAction.ts:344
setSoundEffect(type: SfxType, inFront?: boolean): IActionConfirmerApi<E, CU>
Parameters
- type: SfxType
- Optional inFront: boolean
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setSoundEffect
- Defined in src/game/game/entity/action/IAction.ts:345

setStaminaReduction

setStaminaReduction(skill?: SkillType, actionTier?: number): IActionConfirmerApi<E, CU>
Parameters
- Optional skill: SkillType
- Optional actionTier: number
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setStaminaReduction
- Defined in src/game/game/entity/action/IAction.ts:341

setUpdateRender

setUpdateRender(): IActionConfirmerApi<E, CU>
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setUpdateRender
- Defined in src/game/game/entity/action/IAction.ts:338

setUpdateTablesAndWeight

setUpdateTablesAndWeight(): IActionConfirmerApi<E, CU>
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setUpdateTablesAndWeight
- Defined in src/game/game/entity/action/IAction.ts:339

setUpdateView

setUpdateView(updateFov?: boolean): IActionConfirmerApi<E, CU>
Parameters
- Optional updateFov: boolean
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setUpdateView
- Defined in src/game/game/entity/action/IAction.ts:337

setUpdateWeight

setUpdateWeight(): IActionConfirmerApi<E, CU>
Returns IActionConfirmerApi<E, CU>
Inherited from IActionApi.setUpdateWeight
- Defined in src/game/game/entity/action/IAction.ts:340

Interface IActionConfirmerApi<E, CU>

Type Parameters

E extends default = default

CU extends IActionUsable = IActionUsable

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly actionStack

Readonly executor

Readonly hasSetCanUse

Readonly lastAction

Readonly type

Methods

addItems

Parameters

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

Returns IActionConfirmerApi<E, CU>

addSkillGains

Parameters

Rest ...skills: [skill: SkillType, multiplier?: number, actionTier?: number, bypass?: true][]

Returns IActionConfirmerApi<E, CU>

Parameters

skill: SkillType

Optional multiplier: number

Optional actionTier: number

Optional bypass: true

Returns IActionConfirmerApi<E, CU>

canProtectedItemBeUsed

Parameters

items: IProtectedItems

Returns true | IActionNotUsable

canUse

Returns IActionNotUsable | CU

getItems

Returns readonly default[]

isArgumentType

Type Parameters

A extends ActionArgument

Parameters

argument: any

index: number

argumentType: A

Returns argument is IActionArgumentTypeMap[A]

isCreatureBlocking

Returns

Parameters

tile: default

Returns boolean

prompt

Type Parameters

PROMPT extends IPromptDescriptionBase<any[]>

Parameters

prompt: PROMPT

Rest ...args: PromptDescriptionArgs<PROMPT>

Returns Promise<boolean>

removeItems

Returns IActionConfirmerApi<E, CU>

Parameters

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

Returns IActionConfirmerApi<E, CU>

setDelay

Parameters

delay: number

Optional replace: boolean

Returns IActionConfirmerApi<E, CU>

setMilestone

Parameters

milestone: Milestone

Optional data: number

Returns IActionConfirmerApi<E, CU>

setParticle

Parameters

color: IRGB

Optional count: number

Optional inFront: boolean

Returns IActionConfirmerApi<E, CU>

Parameters

`Readonly` actionStack

`Readonly` executor

`Readonly` hasSetCanUse

`Readonly` lastAction

`Readonly` type

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

`Rest` ...skills: [skill: SkillType, multiplier?: number, actionTier?: number, bypass?: true][]

`Optional` multiplier: number

`Optional` actionTier: number

`Optional` bypass: true

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

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

`Optional` replace: boolean

`Optional` data: number

`Optional` count: number

`Optional` inFront: boolean

`Optional` inFront: boolean

`Optional` turnType: TurnTypeFlag

`Optional` inFront: boolean

`Optional` skill: SkillType

`Optional` actionTier: number

`Optional` updateFov: boolean