Class Item

constructor

• new Item(init, dataPointer, currencyPointer): Item

• Creates a new item.

  Parameters

  • init: ItemInit

    The initialization data for the item.
  • dataPointer: Pointer<ItemData>

    The pointer to the data of the item.
  • currencyPointer: Pointer<CurrencyStatic<[], string, [], string>>

    The pointer to the currency static class that the item is being run on.

  Returns Item

cost

// An item that costs 10 times the level
(level) => level.mul(10);
Copy

defaultAmount

effect

id

name

amount

• get amount(): Decimal

• The amount of the item that was bought.

  Returns Decimal

  The amount of the item that was bought.

  Deprecated

  This does not account for items that were bought on different tiers.

• set amount(n): void

• The default amount of the item. Automatically set to 0 if not provided.

  Parameters

  • n: DecimalSource

  Returns void

  Deprecated

  This does not account for items that were bought on different tiers. You should use your own amount system.

data

• get data(): ItemData

• Returns ItemData

  The data of the item.

description

• get description(): string

• The description of the item. Can be a string or a function that returns a string.

  Returns string

  Example

  // A dynamic description that returns a string
  const description = (a, b) => `This is a ${a} that returns a ${b}`;
  
  // ... create item here (see currencyStatic.addUpgrade)
  
  const item = currencyStatic.getUpgrade("itemID");
  
  // Getter property
  console.log(item.description); // "This is a undefined that returns a undefined"
  
  // Getter function
  console.log(item.descriptionFn("dynamic", "string")); // "This is a dynamic that returns a string"
  Copy

• set description(value): void

• The description of the item. Can be a string or a function that returns a string.

  Parameters

  • value: string | ((level: Decimal, itemContext: Item, currencyContext: CurrencyStatic<[], string, [], string>) => string)

  Returns void

  Example

  // A dynamic description that returns a string
  const description = (a, b) => `This is a ${a} that returns a ${b}`;
  
  // ... create item here (see currencyStatic.addUpgrade)
  
  const item = currencyStatic.getUpgrade("itemID");
  
  // Getter property
  console.log(item.description); // "This is a undefined that returns a undefined"
  
  // Getter function
  console.log(item.descriptionFn("dynamic", "string")); // "This is a dynamic that returns a string"
  Copy