1681-engine / ui / Bar

Class: Bar

Defined in: src/ui/Bar.ts:40

A health or progress bar with a delayed drain: a loss shows as a trail that holds a moment, then drains down to the bar, so the player sees how much a hit took. Ticks only while the trail is draining.

Extends

• Widget

Implements

• UiTicking

Constructors

Constructor

new Bar(options): Bar;

Defined in: src/ui/Bar.ts:47

Parameters

Parameter	Type
options	BarOptions

Returns

Bar

Overrides

Widget.constructor

Properties

boxH

protected boxH: number = 0;

Defined in: src/ui/Widget.ts:23

Inherited from

Widget.boxH

---

boxW

protected boxW: number = 0;

Defined in: src/ui/Widget.ts:22

Inherited from

Widget.boxW

---

focusable

focusable: boolean = false;

Defined in: src/ui/Widget.ts:21

Whether the focus manager may land on it (buttons, sliders, toggles).

Inherited from

Widget.focusable

Accessors

boxHeight

Get Signature

get boxHeight(): number;

Defined in: src/ui/Widget.ts:31

Returns

number

Inherited from

Widget.boxHeight

---

boxWidth

Get Signature

get boxWidth(): number;

Defined in: src/ui/Widget.ts:27

Returns

number

Inherited from

Widget.boxWidth

---

enabled

Get Signature

get enabled(): boolean;

Defined in: src/ui/Widget.ts:35

Returns

boolean

Set Signature

set enabled(v): void;

Defined in: src/ui/Widget.ts:39

Parameters

Parameter	Type
v	boolean

Returns

void

Inherited from

Widget.enabled

---

focused

Get Signature

get focused(): boolean;

Defined in: src/ui/Widget.ts:47

Returns

boolean

Inherited from

Widget.focused

---

host

Get Signature

get protected host(): UiHost | null;

Defined in: src/ui/Widget.ts:90

The root it sits under, looked up when needed: a widget may be built before it is added.

Returns

UiHost | null

Inherited from

Widget.host

---

trailValue

Get Signature

get trailValue(): number;

Defined in: src/ui/Bar.ts:62

The trail's length (what was held before the last losses), 0–1.

Returns

number

---

value

Get Signature

get value(): number;

Defined in: src/ui/Bar.ts:57

Returns

number

Methods

activate()

activate(): void;

Defined in: src/ui/Widget.ts:82

Accept pressed while focused (Enter, the pad's A).

Returns

void

Inherited from

Widget.activate

---

canFocus()

canFocus(): boolean;

Defined in: src/ui/Widget.ts:75

Focusable now: enabled, shown, and every parent shown.

Returns

boolean

Inherited from

Widget.canFocus

---

childResized()

protected childResized(_child): void;

Defined in: src/ui/Widget.ts:108

A child widget's box changed size by itself (a Label given a longer text). A widget that places a child by its size (a Button centring its content) lays it out again here; the default does nothing, so a Stack still waits for its layout() and a change does not ripple up through every container.

Parameters

Parameter	Type
_child	Widget

Returns

void

Inherited from

Widget.childResized

---

makeInteractive()

protected makeInteractive(): void;

Defined in: src/ui/Widget.ts:98

Hit-tested by Pixi, and every press on it is kept from the world. A widget whose drawing has gaps (a scroll view, an empty panel) also sets a hitArea over its box, so a press between its pieces is not the world's.

Returns

void

Inherited from

Widget.makeInteractive

---

navigate()

navigate(_dir): boolean;

Defined in: src/ui/Widget.ts:85

A direction pressed while focused; true when the widget used it (a slider stepping) so focus stays.

Parameters

Parameter	Type
_dir	NavDirection

Returns

boolean

Inherited from

Widget.navigate

---

notifyResized()

protected notifyResized(): void;

Defined in: src/ui/Widget.ts:111

Tells the parent widget this one's box changed size by itself.

Returns

void

Inherited from

Widget.notifyResized

---

place()

place(x, y): this;

Defined in: src/ui/Widget.ts:68

Moves it, on whole pixels under a pixel-perfect root.

Parameters

Parameter	Type
x	number
y	number

Returns

this

Inherited from

Widget.place

---

redraw()

protected redraw(): void;

Defined in: src/ui/Bar.ts:91

Draws the current size and state.

Returns

void

Overrides

Widget.redraw

---

resize()

resize(width, height): this;

Defined in: src/ui/Widget.ts:59

Resizes the layout box (whole pixels under a pixel-perfect root) and redraws.

Parameters

Parameter	Type
width	number
height	number

Returns

this

Inherited from

Widget.resize

---

setFocused()

setFocused(v): void;

Defined in: src/ui/Widget.ts:52

Called by the focus manager.

Parameters

Parameter	Type
v	boolean

Returns

void

Inherited from

Widget.setFocused

---

setValue()

setValue(value, instant?): this;

Defined in: src/ui/Bar.ts:67

Sets the bar, 0–1; instant drops the trail with it (a respawn, a new target).

Parameters

Parameter	Type	Default value
value	number	undefined
instant	boolean	false

Returns

this

---

tick()

tick(dtMs): boolean;

Defined in: src/ui/Bar.ts:83

Advances the drain; a bar under a UiRoot is ticked for you, one standing alone is ticked by the game.

Parameters

Parameter	Type
dtMs	number

Returns

boolean

Implementation of

UiTicking.tick