Class ActionSource

constructor

• new ActionSource(
      source: Familiar | Item | Skill | (Familiar | Item | Skill)[],
      potential: () => number,
      macro: Macro,
      constraints?: ActionConstraints,
  ): ActionSource

  Parameters

  • source: Familiar | Item | Skill | (Familiar | Item | Skill)[]

    Source(s) of the action (e.g. item, skill, or familiar needed).

  • potential: () => number

    Function returning how many times this action can be used.

  • macro: Macro

    Macro to execute this action in combat.

  • constraints: ActionConstraints = {}

    Constraints required for this action to be available.

  Returns ActionSource

constraints

macro

potential

source

available

• available(): boolean

  Returns boolean

  Whether the action is available.

cost

• cost(): number

  Returns number

  Cost in meat per usage of the action.

ensure

• ensure(otherRequirements?: Requirement): void

  Perform all preparation necessary to make this action available. Throws an error if preparation fails.

  Parameters

  • OptionalotherRequirements: Requirement

    Any other equipment requirements.

  Returns void

isFree

• isFree(): boolean

  Returns boolean

  Whether the action costs 0 meat to use.

isUnlimited

• isUnlimited(): boolean

  Returns boolean

  Whether unlimited uses of the action are available.

merge

• merge(...others: ActionSource[]): ActionSource | null

  Create a compound action source with merged constraints.

  Parameters

  • ...others: ActionSource[]

    Other actions to have available.

  Returns ActionSource | null

  Merged constraints, or null if they are inconsistent.

name

• name(): string

  Returns string

  Name of the action source.

prepare

• prepare(otherRequirements?: Requirement): boolean

  Perform all preparation necessary to make this action available.

  Parameters

  • OptionalotherRequirements: Requirement

    Any other equipment requirements.

  Returns boolean

  Whether preparation succeeded.

StaticdefaultPriceFunction

• defaultPriceFunction(item: Item): number

  Parameters

  • item: Item

  Returns number