UI Progress Bar

Horizontal progress percentage visualizer for health bars, loading indicators, and gauges.

Type: UIProgressBarNode · Category: UI & Interface · Also found as: uiprogressbar

Properties

Property	Type	Default	Description
size	vec2	(360, 22)	Width and height (px). Range 4 to 1280.
label	string	"Progress"	Caption shown next to the control.
value	number	0.5	Progress (between min and max). Range 0 to 100.
minValue	number	0	Lowest value. Range 0 to 100.
maxValue	number	1	Highest value. Range 1 to 1000.
fillColor	color	#10b981ff	Colour of the filled part.
direction	enum: Horizontal, Vertical	Horizontal	Direction the bar fills.
showText	boolean	true	Show the percentage.

Plus the common properties every node has.

Lua methods

Call them on the node (self.node in its script, or self.node:get_node("path")). Every node also has the Node methods.

UIProgressBarNode:get_property(path)

Reads an Inspector property by its path (vectors and colours as tables); “script.” reads a field of the node’s script.

local value = self.node:get_property("size")

• path UIProgressBarNodeProperty|string

Returns any

UIProgressBarNode:set_property(path, value, y)

Sets an Inspector property by its path: vectors as {x, y} or x, y; colours as {r, g, b[, a]} 0..1 or “#rrggbb[aa]”; enums by name; “script.” a field of the node’s script.

self.node:set_property("size", 100, 50)

• path UIProgressBarNodeProperty|string
• value any
• y? number

In a scene file

{
  "type": "UIProgressBarNode",
  "name": "UIProgressBar",
  "position": [
    0,
    0
  ],
  "properties": {
    "size": [
      360,
      22
    ],
    "label": "Progress",
    "value": 0.5
  }
}