Kiln API / kiln / UiState

Class: UiState

The HUD as retained data: res.mut(Ui).text('score', 'Coins 3'), .bar('hp', 0.5), .button('start', 'Start', { anchor: 'center', action: 'jump' }). Elements stay until removed (remove(id), or clear('menu.') for every id with that prefix). Calls with unchanged values cost nothing, so systems may set them every step. Headless the same data exists (tests read app.res(Ui).get('score')?.text); in the browser it is drawn as DOM over the canvas.

Constructors

Constructor

new UiState(): UiState;

Returns

UiState

Properties

nodes

nodes: Record<string, UiNode> = {};

---

version

version: number = 0;

Bumped on every change; the DOM sync skips frames where it didn't move.

---

clicks

clicks: string[] = [];

Clicks waiting to become UiClick events.

Methods

text()

text(
   id, 
   text, 
   options?
): void;

Sets a text element.

Parameters

Parameter	Type
id	string
text	string | number
options	UiOptions

Returns

void

---

bar()

bar(
   id, 
   value, 
   options?
): void;

Sets a progress bar: value 0..1 (clamped).

Parameters

Parameter	Type
id	string
value	number
options	BarOptions

Returns

void

---

button()

button(
   id, 
   label, 
   options?
): void;

Sets a button. Clicking it emits UiClick { id }.

Parameters

Parameter	Type
id	string
label	string
options	ButtonOptions

Returns

void

---

get()

get(id): Readonly<UiNode> | undefined;

The element with this id, or undefined.

Parameters

Parameter	Type
id	string

Returns

Readonly<UiNode> | undefined

---

has()

has(id): boolean;

Parameters

Parameter	Type
id	string

Returns

boolean

---

show()

show(id, visible?): void;

Shows or hides an element without removing it.

Parameters

Parameter	Type	Default value
id	string	undefined
visible	boolean	true

Returns

void

---

remove()

remove(id): void;

Removes an element. Removing a missing id is a no-op.

Parameters

Parameter	Type
id	string

Returns

void

---

clear()

clear(prefix?): void;

Removes every element whose id starts with prefix (all of them with no prefix).

Parameters

Parameter	Type	Default value
prefix	string	''

Returns

void

---

click()

click(id): void;

Clicks a button as a player would; UiClick is emitted in the next Input phase.

Parameters

Parameter	Type
id	string

Returns

void

---

toJSON()

toJSON(): object;

Returns

object

nodes

nodes: Record<string, UiNode>;

---

restore()

restore(json): void;

Parameters

Parameter	Type
json	{ nodes: Record<string, UiNode>; }
json.nodes	Record<string, UiNode>

Returns

void