Phaser 3 UI Components

Class: UIProgressBar

PhaserComps.UIComponents. UIProgressBar

Progress bar.

Setup states progress_0 and progress_100 in Animate, and all differences between them will be interpolated to the current progress value. Also you can create intermediate states, if you want to control intermediate interpolation behaviour. For example, if you want an indicator to rotate a full circle, you need to create additional intermediate states progress_30 and progress_70 with 30% and 70$ of rotation, to be sure, that indicator will rotate in the needed direction.

Also you can use intermediate states to make interpolation not linear for all progress range.

Available properties for interpolating are x, y, scaleX, scaleY, angle, alpha

new UIProgressBar( [parent] [, key])

Parameters:
Name Type Argument Description
parent PhaserComps.UIComponents.UIComponentPrototype <optional>

UIComponentPrototype instance to find clip inside
key String <optional>

key to find clip inside parent
Properties:
Name Type Description
value Number

current progress value, between 0 and 1

Extends

Methods

appendClip(clip)

Append a instance to this to control it. State setup will be processed immediately.
Use only for root instance, child instances will be appended automatically depending on state of this.

Parameters:
Name Type Description
clip PhaserComps.ComponentClip

ComponentView instance to append
Inherited From:

<protected> destroy( [fromScene])

Destroy ComponentPrototype and clip, if exists

Parameters:
Name Type Argument Default Description
fromScene Boolean <optional>
 false
Inherited From:

<protected> doState()

Call doState to setup new state, id is provided by getStateId

Inherited From:
See:

<protected> getStateId()

Current state id, used by doState method

Inherited From:
Returns:
Type
String

getText(key)

Returns saved text by key, if it was set previously

Parameters:
Name Type Description
key String
Inherited From:
Returns:

text value

Type
String | Array.<String>

<protected> onClipAppend(clip)

Override this, if you want to do something, when new clip removed,

Parameters:
Name Type Description
clip PhaserComps.ComponentClip
Inherited From:

<protected> onClipProcess()

Override this, if you want to do something, when state or clip changes.

Inherited From:

<protected> onClipRemove(clip)

Override this, if you want to do something, when new clip removed, like remove clip events listeners.

Parameters:
Name Type Description
clip
Inherited From:

<protected> removeClip()

Inherited From:

setText(key, text)

Set text value to the textfield with provided key. Text value is saved in the component's instance dictionary and will be set to the textField on every state change

Parameters:
Name Type Description
key String

TextField key
text String | Array.<String>

text string
Inherited From: