Class BoostObject

constructor

• new BoostObject(init): BoostObject

• Constructs a new boost object.

  Parameters

  • init: BoostsObjectInit

    The initialization object.

  Returns BoostObject

descriptionFn

id

name

order

value

// A boost that adds 10 to the input value.
(input) => input.add(10)

// A boost that multiplies the input value by 2.
(input) => input.mul(2)
Copy

desc

• get desc(): string

• Returns string

  The description of the boost.

  Deprecated

  Use description instead

description

• get description(): string

• An optional description of the boost. Can be a string or a function that returns a string. Made into a getter function to allow for dynamic descriptions.

  Returns string

  Example

  // A dynamic description that returns a string
  const description = (a, b) => `This is a ${a} that returns a ${b}`;
  // ... create boost
  const boost = boost.getBoost("boostID");
  
  // Getter property
  console.log(boost.description); // "This is a undefined that returns a undefined"
  
  // Getter function
  console.log(boost.descriptionFn("dynamic", "string")); // "This is a dynamic that returns a string"
  Copy