Skip to main content

Function: addUiProgressBarComponent()

addUiProgressBarComponent(world, entity, options): UiProgressBarEcsComponent

Defined in: ui/components/ui-progress-bar-component.ts:65

Attaches a UiProgressBarEcsComponent to entity.

Parameters​

world​

EcsWorld

The ECS world entity belongs to.

entity​

number

The entity to attach the component to.

options​

UiProgressBarRequiredOptions & Partial<UiProgressBarDefaultedOptions>

Options for configuring the progress bar. fill has no sensible default and must always be provided; value defaults to minValue.

Returns​

UiProgressBarEcsComponent

The attached component, for reading/setting value directly.