1
0
Fork 0
mirror of https://github.com/Acamaeda/The-Modding-Tree.git synced 2024-11-24 17:31:50 +00:00
The-Modding-Tree/docs/buyables.md
2020-10-01 01:45:05 -04:00

1.5 KiB

Buyables

Buyables are things that can be bought multiple times with scaling costs. If you set a respec function, the player can reset the purchases to get their currency back.

Buyables should be formatted like this:

buyables: {
    rows: # of rows
    cols: # of columns
    respec() {}, **optional**, implement it to reset things and give back your currency.
                 Having this function makes a respec button appear
    respecText: **optional**, text that appears on the respec button
    11: {
        desc: "Blah",
        etc
    }
    etc
}

Features:

  • title: optional, displayed at the top in a larger font

  • cost(x): cost for buying xth buyable, can be an object if there are multiple currencies

  • effect(x): optional, A function that calculates and returns the current values of bonuses for having x of this buyable. Can return a value or an object containing multiple values.

  • display(): A function returning everything that should be displayed on the rebuyable after the title, likely including the description, amount bought, cost, and current effect

  • unl(): A function returning a bool to determine if the buyable is visible or not.

  • canAfford(): A function returning a bool to determine if you can buy one of the buyables.

  • buy(): A function that implements buying one of the buyable.

  • buyMax(): optional, A function that implements buying as many of the buyable as possible.