Class Game

constructor

• new Game(config?): Game

• Creates a new instance of the game class.

  Parameters

  • Optionalconfig: GameConfigOptions

    The configuration object for the game.

  Returns Game

  Example

  const myGame = new game({
      name: {
          title: "My Game",
          id: "my-game",
      },
      // Additional options here
  });
  Copy

Readonlyconfig

ReadonlydataManager

ReadonlyeventManager

ReadonlykeyManager

addAttribute

• addAttribute<B>(name, useBoost?, initial?): GameAttribute<B>

• Adds a new attribute to the game. GameAttribute is the class. It automatically adds the attribute and attributeStatic objects to the data and static objects for saving and loading.

  Type Parameters

  • B extends boolean = true

  Parameters

  • name: string

    The name of the attribute.
  • useBoost: B = ...

    Indicates whether to use boost for the attribute.
  • initial: DecimalSource = 0

    The initial value of the attribute.

  Returns GameAttribute<B>

  The newly created attribute.

  Example

  const myAttribute = game.addAttribute("myAttribute");
  Copy

addCurrency

• addCurrency<N, U, I>(name, upgrades?, items?): GameCurrency<N, U, I>

• Adds a new currency section to the game. GameCurrency is the class. It automatically adds the currency and currencyStatic objects to the data and static objects for saving and loading.

  Type Parameters

  • N extends string

    The name
  • U extends Readonly<UpgradeInit>[] = []

    The upgrade names for the currency. See CurrencyStatic for more information.
  • I extends Readonly<ItemInit>[] = []

    The item names for the currency. See CurrencyStatic for more information.

  Parameters

  • name: N

    The name of the currency section. This is also the name of the data and static objects, so it must be unique.
  • upgrades: U = ...

    The upgrades for the currency.
  • items: I = ...

    The items for the currency.

  Returns GameCurrency<N, U, I>

  A new instance of the gameCurrency class.

  Example

  const currency = game.addCurrency("currency");
  currency.static.gain();
  console.log(currency.value); // Decimal.dOne
  Copy

addReset

• addReset(...args): GameReset

• Creates a new game reset object with the specified currencies to reset.

  Parameters

  • Rest...args: [currenciesToReset: GameCurrency<string, [], []> | GameCurrency<string, [], []>[], extender?: GameReset | GameReset[], onReset?: ((resetContext: GameReset) => void), condition?: boolean | ((resetContext: GameReset) => boolean)]

    The arguments for the game reset. See GameReset for more information.

  Returns GameReset

  The newly created game reset object.

  Deprecated

  Use the class GameReset instead. This method is a wrapper for the class and does not provide any additional functionality.

addResetFromObject

• addResetFromObject(object): GameReset

• Creates a new game reset object from an object.

  Parameters

  • object: GameResetFromObject

    The object to create the game reset from.

  Returns GameReset

  The newly created game reset object.

  Deprecated

  Use the static method GameReset.fromObject instead. This method is a wrapper for the static method and does not provide any additional functionality.

changeFps

• changeFps(fps): void

• Changes the framerate of the game.

  Parameters

  • fps: number

    The new framerate to use.

  Returns void

init

• init(): void

• Initializes the game. Also initializes the data manager. See DataManager.init for more information.

  Returns void