Class GameCurrency<CurrencyName, UpgradeInitArray, ItemInitArray>

Represents a game currency. Currency is the data class. This class extends CurrencyStatic and adds additional functionality for Game.

Type Parameters

CurrencyName extends string = string
The name of the currency. This is optional, and you can use it for display purposes.
UpgradeInitArray extends Readonly<UpgradeInit>[] = []
The upgrade names for the currency. See CurrencyStatic for more information.
ItemInitArray extends Readonly<ItemInit>[] = []

Hierarchy (view full)

CurrencyStatic<UpgradeInitArray, UpgradeInitArrayType<UpgradeInitArray>, ItemInitArray, ItemInitArrayType<ItemInitArray>>
- GameCurrency

Index

Constructors

constructor

new GameCurrency<CurrencyName, UpgradeInitArray, ItemInitArray>(currencyStaticParams, gamePointer, name): GameCurrency<CurrencyName, UpgradeInitArray, ItemInitArray>
Creates a new instance of the game class.
Type Parameters
- CurrencyName extends string = string
- UpgradeInitArray extends Readonly<UpgradeInit>[] = []
- ItemInitArray extends Readonly<ItemInit>[] = []
Parameters
- currencyStaticParams: [pointer: Pointer<Currency>, upgrades?: UpgradeInitArray, items?: ItemInitArray, defaults: {
  defaultBoost: Decimal;
  defaultVal: Decimal;
  }]
  The parameters for the currency static class.
- gamePointer: Game
  A pointer to the game instance.
- name: CurrencyName
  The name of the currency. This is optional, and you can use it for display purposes.
Returns GameCurrency<CurrencyName, UpgradeInitArray, ItemInitArray>
Overrides CurrencyStatic.constructor
- Defined in game/GameCurrency.ts:65

Properties

`Readonly`boost

boost: Boost

A boost object that affects the currency gain.

`Readonly`defaultBoost

defaultBoost: Decimal

The default boost of the currency.

`Readonly`defaultVal

defaultVal: Decimal

The default value of the currency.

`Optional` `Readonly`game

game?: Game

The game pointer/reference

`Readonly`items

items: Record<ItemInitArrayType<ItemInitArray>, Item>

An array that represents items and their effects.

`Readonly`name

name: CurrencyName

The name of the currency. This is optional, and you can use it for display purposes.

`Protected` `Readonly`pointerFn

pointerFn: (() => Currency)

A function that returns the pointer of the data

`Readonly`upgrades

upgrades: Record<UpgradeInitArrayType<UpgradeInitArray>, UpgradeStatic>

An array that represents upgrades

Accessors

data

get data(): Currency
Returns Currency
The data for the currency.

Deprecated
Use pointer instead. This property is only here for backwards compatibility.
- Defined in game/GameCurrency.ts:44

`Protected`pointer

get pointer(): Currency
Returns Currency
The pointer of the data.
Inherited from CurrencyStatic.pointer
- Defined in classes/Currency.ts:79

static

get static(): this
Returns this
The static data for the currency.

Deprecated
Use this class as a static class as it now has all the properties of CurrencyStatic. This property is only here for backwards compatibility.
- Defined in game/GameCurrency.ts:52

value

get value(): Decimal
The current value of the currency. Note: If you want to change the value, use gain instead.

Returns Decimal
The current value of the currency.
Inherited from CurrencyStatic.value
- Defined in classes/Currency.ts:97
set value(value): void
Parameters
- value: Decimal
Returns void
Inherited from CurrencyStatic.value
- Defined in classes/Currency.ts:100

Methods

addItem

addItem(items, runEffectInstantly?): void
Adds an item.
Parameters
- items: ItemInit | ItemInit[]
  The items to add.
- runEffectInstantly: boolean = true
  Whether to run the effect immediately. Defaults to true.
Returns void
Inherited from CurrencyStatic.addItem
- Defined in classes/Currency.ts:583

addUpgrade

addUpgrade(upgrades, runEffectInstantly?): UpgradeStatic[]

Creates upgrades. To update an upgrade, use updateUpgrade instead.

Parameters

upgrades: UpgradeInit | UpgradeInit[]
An array of upgrade objects.
runEffectInstantly: boolean = true
Whether to run the effect immediately. Defaults to true.

Returns UpgradeStatic[]

The added upgrades.

Example

currency.addUpgrade({
    id: "healthBoost", // The ID of the upgrade, used to retrieve it later
    name: "Health Boost", // The name of the upgrade, for display purposes (optional, defaults to the ID)
    description: "Increases health by 10.", // The description of the upgrade, for display purposes (optional, defaults to "")
    cost: (level) => level.mul(10), // Cost of the upgrade, 10 times the level
    maxLevel: 10, // Maximum level of the upgrade (optional, defaults to 1)
    // Effect of the upgrade (runs when the upgrade is bought, and instantly if runEffectInstantly is true)
    effect: (level, context) => {
        // Set / update the boost
        // health: currencyStatic
        health.boost.setBoost(
            "healthBoost",
            "Health Boost",
            "Boosts health by 2x per level.",
            n => n.mul(Decimal.pow(2, level.sub(1))),
            2,
        );
    }
});

buyItem

buyItem(id, tier?, target?): boolean
Buys an item based on its ID or array position if enough currency is available.
Parameters
- id: ItemInitArrayType<ItemInitArray>
  The ID or position of the item to buy or upgrade.
- Optionaltier: DecimalSource
  The tier of the item that to calculate.
- Optionaltarget: DecimalSource
  The target level or quantity to reach for the item. See the argument in calculateItem.
Returns boolean
Returns true if the purchase or upgrade is successful, or false if there is not enough currency or the item does not exist.
Inherited from CurrencyStatic.buyItem
- Defined in classes/Currency.ts:646

buyUpgrade

buyUpgrade(id, target?, mode?, iterations?): boolean
Buys an upgrade based on its ID or array position if enough currency is available.
Parameters
- id: UpgradeInitArrayType<UpgradeInitArray>
  The ID or position of the upgrade to buy or upgrade.
- Optionaltarget: DecimalSource
  The target level or quantity to reach for the upgrade. See the argument in calculateUpgrade.
- Optionalmode: MeanMode
  See the argument in calculateUpgrade.
- Optionaliterations: number
  See the argument in calculateUpgrade.
Returns boolean
Returns true if the purchase or upgrade is successful, or false if there is not enough currency or the upgrade does not exist.
Example
```
// Attempt to buy up to 10 healthBoost upgrades at once
currency.buyUpgrade("healthBoost", 10);
```
Inherited from CurrencyStatic.buyUpgrade
- Defined in classes/Currency.ts:527

calculateItem

calculateItem(id, tier?, target?): [amount: Decimal, cost: Decimal]
Calculates the cost and how many items you can buy. See calculateItem for more information.
Parameters
- id: ItemInitArrayType<ItemInitArray>
  The ID or position of the item to calculate.
- Optionaltier: DecimalSource
  The tier of the item that to calculate.
- Optionaltarget: DecimalSource
  The target level or quantity to reach for the item. If omitted, it calculates the maximum affordable quantity.
Returns [amount: Decimal, cost: Decimal]
The amount of items you can buy and the cost of the items. If you can't afford any, it returns [Decimal.dZero, Decimal.dZero].
Inherited from CurrencyStatic.calculateItem
- Defined in classes/Currency.ts:626

calculateUpgrade

calculateUpgrade(id, target?, mode?, iterations?): [amount: Decimal, cost: Decimal]
Calculates the cost and how many upgrades you can buy. See calculateUpgrade for more information.
Parameters
- id: UpgradeInitArrayType<UpgradeInitArray>
  The ID or position of the upgrade to calculate.
- target: DecimalSource = Infinity
  The target level or quantity to reach for the upgrade. If omitted, it calculates the maximum affordable quantity.
- Optionalmode: MeanMode
  See the argument in calculateUpgrade.
- Optionaliterations: number
  See the argument in calculateUpgrade.
Returns [amount: Decimal, cost: Decimal]
The amount of upgrades you can buy and the cost of the upgrades. If you can't afford any, it returns [Decimal.dZero, Decimal.dZero].
Example
```
// Calculate how many healthBoost upgrades you can buy and the cost of the upgrades
const [amount, cost] = currency.calculateUpgrade("healthBoost", 10);
```
Inherited from CurrencyStatic.calculateUpgrade
- Defined in classes/Currency.ts:429

gain

gain(dt?): Decimal
The new currency value after applying the boost.
Parameters
- dt: DecimalSource = 1000
  Delta time / multiplier in milliseconds, assuming you gain once every second. Ex. 500 = 0.5 seconds = half gain.
Returns Decimal
What was gained, NOT the new value.
Example
```
// Gain a random number between 1 and 10, and return the amount gained.
currency.gain(Math.random() * 10000);
```
Inherited from CurrencyStatic.gain
- Defined in classes/Currency.ts:232

getItem

getItem<T>(id): IsPrimitiveString<ItemInitArrayType<ItemInitArray>> extends false
? Item
: null | Item
Retrieves an item object based on the provided id.
Type Parameters
- T extends string
Parameters
- id: T
  The id of the item to retrieve.
Returns IsPrimitiveString<ItemInitArrayType<ItemInitArray>> extends false
? Item
: null | Item
The item object if found, otherwise null.
Inherited from CurrencyStatic.getItem
- Defined in classes/Currency.ts:612

getNextCost

getNextCost(id, target?, mode?, iterations?): Decimal
Calculates how much is needed for the next upgrade.
Parameters
- id: UpgradeInitArrayType<UpgradeInitArray>
  Index or ID of the upgrade
- target: DecimalSource = 1
  How many before the next upgrade
- Optionalmode: MeanMode
  See the argument in calculateUpgrade.
- Optionaliterations: number
  See the argument in calculateUpgrade.
Returns Decimal
The cost of the next upgrade.
Deprecated
Use getNextCostMax instead as it is more versatile.
Example
```
// Calculate the cost of the next healthBoost upgrade
const nextCost = currency.getNextCost("healthBoost");
```
Inherited from CurrencyStatic.getNextCost
- Defined in classes/Currency.ts:467

getNextCostMax

getNextCostMax(id, target?, mode?, iterations?): Decimal
Calculates the cost of the next upgrade after the maximum affordable quantity.
Parameters
- id: UpgradeInitArrayType<UpgradeInitArray>
  Index or ID of the upgrade
- target: DecimalSource = 1
  How many before the next upgrade
- Optionalmode: MeanMode
  See the argument in calculateUpgrade.
- Optionaliterations: number
  See the argument in calculateUpgrade.
Returns Decimal
The cost of the next upgrade.
Example
```
// Calculate the cost of the next healthBoost upgrade
currency.gain(1e6); // Gain 1 thousand currency
console.log(currency.calculateUpgrade("healthBoost")); // The maximum affordable quantity and the cost of the upgrades. Ex. [new Decimal(100), new Decimal(1000)]
console.log(currency.getNextCostMax("healthBoost")); // The cost of the next upgrade after the maximum affordable quantity. (The cost of the 101st upgrade)
```
Inherited from CurrencyStatic.getNextCostMax
- Defined in classes/Currency.ts:498

getUpgrade

getUpgrade<T>(id): IsPrimitiveString<UpgradeInitArrayType<UpgradeInitArray>> extends false
? UpgradeStatic
: null | UpgradeStatic
Retrieves an upgrade object based on the provided id.
Type Parameters
- T extends string
  The type of the upgrade ID.
Parameters
- id: T
  The id of the upgrade to retrieve.
Returns IsPrimitiveString<UpgradeInitArrayType<UpgradeInitArray>> extends false
? UpgradeStatic
: null | UpgradeStatic
The upgrade object if found, otherwise null.
Example
```
const upgrade = currency.getUpgrade("healthBoost");
console.log(upgrade); // upgrade object
```
Inherited from CurrencyStatic.getUpgrade
- Defined in classes/Currency.ts:267

onLoadData

onLoadData(): void
Updates / applies effects to the currency on load.

Returns void
Inherited from CurrencyStatic.onLoadData
- Defined in classes/Currency.ts:158

queryUpgrade

queryUpgrade(id): UpgradeStatic[]

Queries upgrades based on the provided id. Returns an array of upgrades that match the id.

Parameters

id: RegExp | UpgradeInitArrayType<UpgradeInitArray> | UpgradeInitArrayType<UpgradeInitArray>[]
The id of the upgrade to query.

Returns UpgradeStatic[]

An array of upgrades that match the id.

Example

const currency = new CurrencyStatic(undefined, [
    { id: "healthBoostSmall", cost: (level) => level.mul(10) },
    { id: "healthBoostLarge", cost: (level) => level.mul(20) },
    { id: "damageBoostSmall", cost: (level) => level.mul(10) },
    { id: "damageBoostLarge", cost: (level) => level.mul(20) },
] as const satisfies UpgradeInit[]);

// Get all health upgrades
const healthUpgrades = currency.queryUpgrade(/health/); // [{ id: "healthBoostSmall", ... }, { id: "healthBoostLarge", ... }]

// Get all small upgrades
const smallUpgrades = currency.queryUpgrade(["healthBoostSmall", "damageBoostSmall"]);
// or
const smallUpgrades2 = currency.queryUpgrade(/.*Small/);

reset

reset(resetCurrency?, resetUpgradeLevels?, runUpgradeEffect?): void
Resets the currency and upgrade levels.
Parameters
- OptionalresetCurrency: boolean
  Whether to reset the currency value. Default is true.
- OptionalresetUpgradeLevels: boolean
  Whether to reset the upgrade levels. Default is true.
- OptionalrunUpgradeEffect: boolean
  Whether to run the upgrade effect. Default is true.
Returns void
Example
```
currency.reset();
console.log(currency.value); // Decimal.dZero, or the default value
```
Inherited from CurrencyStatic.reset
- Defined in classes/Currency.ts:174
reset(reset?): void
Parameters
- Optionalreset: Partial<CurrencyStaticResetOptions>
Returns void
Inherited from CurrencyStatic.reset
- Defined in classes/Currency.ts:175

runItemEffect

runItemEffect(item, tier?): void
Runs the effect of an upgrade or item.
Parameters
- item: Item
  The item to run the effect for.
- tier: DecimalSource = Decimal.dOne
  The tier of the item that was bought.
Returns void
Inherited from CurrencyStatic.runItemEffect
- Defined in classes/Currency.ts:411

runUpgradeEffect

runUpgradeEffect(upgrade): void
Runs the effect of an upgrade or item.
Parameters
- upgrade: UpgradeStatic
  The upgrade to run the effect for.
Returns void
Inherited from CurrencyStatic.runUpgradeEffect
- Defined in classes/Currency.ts:402

updateUpgrade

updateUpgrade(id, newUpgrade): void
Updates an upgrade. To create an upgrade, use addUpgrade instead.
Parameters
- id: UpgradeInitArrayType<UpgradeInitArray>
  The id of the upgrade to update.
- newUpgrade: Partial<UpgradeInit>
  The new upgrade object.
Returns void
Example
```
currency.updateUpgrade("healthBoost", {
    name: "New Health Boost".
    cost: (level) => level.mul(20),
    maxLevel: 20,
    effect: (level, context) => {
        console.log("Health Boost effect");
    }
});
```
Inherited from CurrencyStatic.updateUpgrade
- Defined in classes/Currency.ts:387

Class GameCurrency<CurrencyName, UpgradeInitArray, ItemInitArray>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GameCurrency<CurrencyName, UpgradeInitArray, ItemInitArray>

Properties

Readonlyboost

ReadonlydefaultBoost

ReadonlydefaultVal

Optional Readonlygame

Readonlyitems

Readonlyname

Protected ReadonlypointerFn

Readonlyupgrades

Accessors

data

Returns Currency

Deprecated

Protectedpointer

Returns Currency

static

Returns this

Deprecated

value

Returns Decimal

Parameters

Returns void

Methods

addItem

Parameters

Returns void

addUpgrade

Parameters

Returns UpgradeStatic[]

Example

buyItem

Parameters

Returns boolean

buyUpgrade

Parameters

Returns boolean

Example

calculateItem

Parameters

Returns [amount: Decimal, cost: Decimal]

calculateUpgrade

Parameters

Returns [amount: Decimal, cost: Decimal]

Example

gain

Parameters

Returns Decimal

Example

getItem

Type Parameters

Parameters

Returns IsPrimitiveString<ItemInitArrayType<ItemInitArray>> extends false ? Item : null | Item

getNextCost

Parameters

Returns Decimal

Deprecated

Example

getNextCostMax

Parameters

Returns Decimal

Example

getUpgrade

Type Parameters

Parameters

Returns IsPrimitiveString<UpgradeInitArrayType<UpgradeInitArray>> extends false ? UpgradeStatic : null | UpgradeStatic

Example

onLoadData

`Readonly`boost

`Readonly`defaultBoost

`Readonly`defaultVal

`Optional` `Readonly`game

`Readonly`items

`Readonly`name

`Protected` `Readonly`pointerFn

`Readonly`upgrades

`Protected`pointer

Returns IsPrimitiveString<ItemInitArrayType<ItemInitArray>> extends false
? Item
: null | Item

Returns IsPrimitiveString<UpgradeInitArrayType<UpgradeInitArray>> extends false
? UpgradeStatic
: null | UpgradeStatic