HUD Stats

Search…

HUD Stats

HUD Stats are number values that automatically appear in the HUD at the top right of the screen and can be controlled via game scripts.

HUD Stats are number values that automatically appear in the HUD at the top right of the screen and can be controlled via game scripts.
​
​
HUD Stats config
1
{
2
  "hudStats": {
3
    "money": {
4
      "icon": "img/ui/money.png",
5
      "name": "Money",
6
      "startingValue": 0,
7
      "minValue": 0
8
    },
9
    "energy": {
10
      "icon": "img/ui/energy.png",
11
      "name": "Energy",
12
      "startingValue": 10,
13
      "minValue": 0,
14
      "maxValue": 10
15
    }
16
  }
17
}
Copied!
Stats are defined in the hudStats part of the config.
icon: path to an image to use as the icon for the stat
name: The name of the stat for display in the HUD
startingValue: The default value for the stat on a new save
minValue: How low this stat can go
maxValue: How high this stat can go
Functions
Set Stat
Add Stat

Last modified 27d ago

Copy link

Contents

HUD Stats config

Functions