Class Boost

constructor

• new Boost(baseEffect?, boosts?): Boost

• Constructs a new boost manager.

  Parameters

  • baseEffect: DecimalSource = 1

    The base effect value to which boosts are applied.
  • Optionalboosts: BoostsObjectInit | BoostsObjectInit[]

    An array of boost objects to initialize with.

  Returns Boost

addBoost

ReadonlybaseEffect

ReadonlyboostArray

calculate

• calculate(base?): Decimal

• Calculates the cumulative effect of all boosts on the base effect.

  Parameters

  • base: DecimalSource = ...

    The base effect value to calculate with. Defaults to the base effect of the boost manager.

  Returns Decimal

  The calculated effect after applying boosts.

  Example

  // Calculate the effect of all boosts
  const finalEffect = boost.calculate();
  Copy

clearBoosts

• clearBoosts(): void

• Clears all boosts from the boost manager.

  Returns void

  Example

  // Clear all boosts
  boost.clearBoosts();
  // boostArray is now []
  // baseEffect is still the same
  Copy

getBoost

• getBoost(id): null | BoostObject

• Gets a boost object by its ID.

  Parameters

  • id: string

    The ID of the boost to retrieve.

  Returns null | BoostObject

  The boost object if found, or null if not found.

  Deprecated

  Use getBoosts instead.

getBoosts

• getBoosts(id): BoostObject[]

• Gets all boosts with the given ID.

  Parameters

  • id: string | RegExp

    A string or regular expression to match the ID of the boosts.

  Returns BoostObject[]

  An array of boost objects with the given ID, or a tuple of the array and the index of the boosts.

  Example

  // Get all boosts with the ID "healthBoost"
  const healthBoosts = boost.getBoosts("healthBoost");
  
  // Get all boosts with the ID "healthBoost" and their index
  const [healthBoosts, healthBoostIndexes] = boost.getBoosts("healthBoost", true);
  
  // Get all boosts with the ID "healthBoost" or "manaBoost"
  const healthAndManaBoosts = boost.getBoosts(/(health|mana)Boost/);
  Copy

• getBoosts(id, index): [BoostObject[], number[]]

• Parameters

  • id: string | RegExp
  • index: boolean

  Returns [BoostObject[], number[]]

removeBoost

• removeBoost(id): void

• Removes a boost by its ID. Only removes the first instance of the id.

  Parameters

  • id: string

    The ID of the boost to remove.

  Returns void

  Example

  // Remove the boost with the ID "healthBoost"
  boost.removeBoost("healthBoost");
  Copy

setBoost

• setBoost(id, name, description, value, order?): void

• Sets or updates a boost with the given parameters.

  Parameters

  • id: string

    The ID of the boost.
  • name: string

    The name of the boost.
  • description: string

    The description of the boost.
  • value: ((input: Decimal) => Decimal)

    The value of the boost (function).

    • • (input): Decimal

      • Parameters

        • input: Decimal

        Returns Decimal

  • Optionalorder: number

    The order of the boost (lower order go first)

  Returns void

  Deprecated

  Use the other overload instead.

  Example

  // Set a boost that multiplies the input value by 2
  boost.setBoost("doubleBoost", "Double Boost", "Doubles the input value", (input) => input.mul(2));
  Copy

• setBoost(boostObj): void

• Sets or updates a boost with the given parameters.

  Parameters

  • boostObj: BoostsObjectInit | BoostsObjectInit[]

    The boost object containing the parameters.

  Returns void

  Example

  // Set a boost that multiplies the input value by 2
  boost.setBoost({
      id: "doubleBoost",
      name: "Double Boost",
      desc: "Doubles the input value",
      value: (input) => input.mul(2),
  });
  Copy