Skip to main content

Interface: CreateProgressBarDefaultedOptions

Defined in: ui/utilities/create-progress-bar.ts:39

Fields of CreateProgressBarOptions with a sensible default; callers may omit these.

Properties​

anchor​

anchor: UiAnchorConfig

Defined in: ui/utilities/create-progress-bar.ts:45

The anchor to place the bar with - see UiAnchor for common presets (e.g. UiAnchor.center({ x: 300, y: 24 })). Defaults to UiAnchor.center({ x: 300, y: 24 }).

anchoredPosition?​

optional anchoredPosition?: Vector2

Defined in: ui/utilities/create-progress-bar.ts:48

Offset of the bar's pivot from its anchor reference point, in reference pixels.

maxValue​

maxValue: number

Defined in: ui/utilities/create-progress-bar.ts:57

The value value maps to a full bar. Defaults to 1.

minValue​

minValue: number

Defined in: ui/utilities/create-progress-bar.ts:54

The value value maps to an empty bar. Defaults to 0.

slices?​

optional slices?: NineSliceOptions

Defined in: ui/utilities/create-progress-bar.ts:51

Overrides trackSprite.slices for the track.

value​

value: number

Defined in: ui/utilities/create-progress-bar.ts:60

The bar's initial value, clamped to [minValue, maxValue]. Defaults to minValue.