1681-engine / ui / UiRootOptions

Interface: UiRootOptions

Defined in: src/ui/UiRoot.ts:18

Properties

bindings?

optional bindings?: Partial<NavBindings>;

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

The action names navigation reads (default ui_up, ui_down, … ui_accept, ui_cancel).

---

parent?

optional parent?: Container<ContainerChild>;

Defined in: src/ui/UiRoot.ts:28

The container the root is added to (default the stage's screen layer). Give a scene's hud and the UI lives and dies with the scene: the scene destroys it on exit, its ticker listener and resize hook with it. On the screen layer it outlives the scene that made it until destroy is called.

---

pixelPerfect?

optional pixelPerfect?: boolean;

Defined in: src/ui/UiRoot.ts:20

Lay out on whole pixels (default: the camera's roundPixels, which pixelPerfect: true turns on).