Interface BoostsObjectInit

An object representing a boost.

interface BoostsObjectInit {
    desc?: Pointer<string>;
    description?: string | ((...args: any[]) => string);
    id: string;
    name?: string;
    order?: number;
    value: ((input: Decimal) => Decimal);
}

Implemented by

Properties

desc? description? id name? order? value

Properties

Optionaldesc

desc?: Pointer<string>

Deprecated

Use description instead. This will do nothing

Optionaldescription

description?: string | ((...args: any[]) => 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.

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"

id

id: string

The ID of the boost.

Optionalname

name?: string

The name of the boost.

Optionalorder

order?: number

The order at which the boost is applied. Lower orders are applied first.

value

value: ((input: Decimal) => Decimal)

The function that calculates the value of the boost.

Type declaration

Example

// 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)

Settings

Member Visibility

On This Page

Properties