1681-engine / ui / Dialog

Class: Dialog

Defined in: src/ui/Dialog.ts:33

A modal window: the world behind it dimmed and deaf to presses, keyboard and gamepad focus trapped inside it, centred and kept inside the screen however small it gets (shrunk, never past its whole scale under pixel art).

Extends

• Widget

Implements

• UiModal

Constructors

Constructor

new Dialog(options): Dialog;

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

Parameters

Parameter	Type
options	DialogOptions

Returns

Dialog

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

---

onClose

onClose: (() => void) | null;

Defined in: src/ui/Dialog.ts:34

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

---

isOpen

Get Signature

get isOpen(): boolean;

Defined in: src/ui/Dialog.ts:65

Returns

boolean

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

---

cancel()

cancel(): boolean;

Defined in: src/ui/Dialog.ts:84

Cancel pressed inside it; true when it used it (it closed).

Returns

boolean

Implementation of

UiModal.cancel

---

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

---

close()

close(): void;

Defined in: src/ui/Dialog.ts:76

Returns

void

---

layoutFor()

layoutFor(viewport): void;

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

Lays itself out for the screen's size.

Parameters

Parameter	Type
viewport	Size

Returns

void

Implementation of

UiModal.layoutFor

---

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

---

open()

open(root): this;

Defined in: src/ui/Dialog.ts:69

Parameters

Parameter	Type
root	UiRoot

Returns

this

---

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/Dialog.ts:111

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