Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IActionApi<E>

Type parameters

Hierarchy

Implemented by

Index

Properties

Readonly actionStack

actionStack: keyof ActionType[]

Readonly executor

executor: E

Readonly lastAction

lastAction: ActionType

Readonly type

Methods

addItems

  • addItems(...items: Array<Item | undefined>): this
  • The items passed to this method will be registered as items potentially to be damaged when the action completes.

    Parameters

    • Rest ...items: Array<Item | undefined>

    Returns this

addSkillGains

  • addSkillGains(...skills: Array<[]>): this
  • addSkillGains(skill: SkillType, amount?: undefined | number, actionTier?: undefined | number, bypass?: undefined | true): this
  • Parameters

    • Rest ...skills: Array<[]>

    Returns this

  • Parameters

    • skill: SkillType
    • Optional amount: undefined | number
    • Optional actionTier: undefined | number
    • Optional bypass: undefined | true

    Returns this

cancelPaddling

  • cancelPaddling(item: Item): this
  • Parameters

    Returns this

getItems

  • getItems(): Stream<Item>
  • Returns the items registered for this action via addItems.

    Returns Stream<Item>

isArgumentType

  • isArgumentType<A>(argument: any, index: number, argumentType: A): argument is ActionArgumentTypeMap<A>
  • Type parameters

    Parameters

    • argument: any
    • index: number
    • argumentType: A

    Returns argument is ActionArgumentTypeMap<A>

removeItems

  • removeItems(): this
  • removeItems(...items: Array<Item | undefined>): this
  • Removes all items added via addItems

    Returns this

  • Removes specific items added by addItems

    Parameters

    • Rest ...items: Array<Item | undefined>

    Returns this

setDelay

  • setDelay(delay: number, replace?: undefined | false | true): this
  • Parameters

    • delay: number
    • Optional replace: undefined | false | true

    Returns this

setMilestone

  • setMilestone(milestone: Milestone, data?: undefined | number): this
  • Parameters

    • milestone: Milestone
    • Optional data: undefined | number

    Returns this

setParticle

  • setParticle(color: IRGB, count?: undefined | number, inFront?: undefined | false | true): this
  • setParticle(color: IRGB, inFront?: undefined | false | true): this
  • setParticle(particle: IActionParticle): this
  • Parameters

    • color: IRGB
    • Optional count: undefined | number
    • Optional inFront: undefined | false | true

    Returns this

  • Parameters

    • color: IRGB
    • Optional inFront: undefined | false | true

    Returns this

  • Parameters

    Returns this

setPassTurn

  • setPassTurn(turnType?: TurnType): this
  • Parameters

    Returns this

setReputationChange

  • setReputationChange(amount: number): this
  • Parameters

    • amount: number

    Returns this

setSoundEffect

  • setSoundEffect(soundEffect: IActionSoundEffect): this
  • setSoundEffect(type: SfxType, inFront?: undefined | false | true): this
  • Parameters

    Returns this

  • Parameters

    • type: SfxType
    • Optional inFront: undefined | false | true

    Returns this

setStaminaReduction

  • setStaminaReduction(skill?: SkillType, actionTier?: undefined | number): this
  • Parameters

    • Optional skill: SkillType
    • Optional actionTier: undefined | number

    Returns this

setUpdateRender

  • setUpdateRender(): this
  • Returns this

setUpdateTablesAndWeight

  • setUpdateTablesAndWeight(): this
  • Returns this

setUpdateView

  • setUpdateView(updateFov?: undefined | false | true): this
  • Parameters

    • Optional updateFov: undefined | false | true

    Returns this

Generated using TypeDoc