UiNodeOptions

interface UiNodeOptions

import type { UiNodeOptions } from '@driftengine/ui2d';

Properties

Name	Type	Description
`direction`readonlyoptional	`'row' \| 'column'`
`width`readonlyoptional	`UiSize`
`height`readonlyoptional	`UiSize`
`padding`readonlyoptional	`number`	One number for all four sides. Set the four fields for anything else.
`gap`readonlyoptional	`number`
`align`readonlyoptional	`UiAlign`
`justify`readonlyoptional	`UiJustify`
`absolute`readonlyoptional	`boolean`	Taken out of the flow and placed at `x`, `y` inside the parent's content box.
`x`readonlyoptional	`number`
`y`readonlyoptional	`number`
`contentWidth`readonlyoptional	`number`	What a `fit` node measures when it has no children: a label's text, an icon's size.
`contentHeight`readonlyoptional	`number`
`hidden`readonlyoptional	`boolean`
`clip`readonlyoptional	`boolean`	Whether this node cuts its descendants to its own rectangle. More Off by default, because most nodes do not clip and one that does costs a scissor change in the pass. A scroll container sets it and a panel sets it; a row of buttons does not.
`scrollX`readonlyoptional	`number`	How far this node's contents are moved under it. Only meaningful with `clip`.
`scrollY`readonlyoptional	`number`
`layer`readonlyoptional	`number`	Draw order beyond tree order. Inherited by descendants that do not set their own.
`background`readonlyoptional	`ArrayLike<number> \| null`
`texture`readonlyoptional	`number`	The sprite slot this node draws from, or `-1` for none.
`frame`readonlyoptional	`SpriteFrame \| null`
`tint`readonlyoptional	`ArrayLike<number> \| null`
`text`readonlyoptional	`string`
`interactive`readonlyoptional	`boolean`
`focusable`readonlyoptional	`boolean`
`name`readonlyoptional	`string`	For a caller to find its own node again. Not read by anything here.