Phaser 3 UI Components

Class: UIContainer

PhaserComps.UIComponents. UIContainer

Base container component. Allows to add dynamically created UIComponents inside other components.

Child components clips must be root components only, not any clip's children.

Note, that UIContainer can be only a child component of another UIComponentPrototype instance.

new UIContainer(parent, key)

Parameters:
Name Type Description
parent PhaserComps.UIComponents.UIComponentPrototype

UIComponentPrototype instance to find clip inside
key String

key to find clip inside parent

Extends

Methods

addChild(child)

Adds child to children list, and adds it to Phaser container instance, if one exists

Parameters:
Name Type Description
child PhaserComps.UIComponents.UIComponentPrototype

child component to add
Returns:

child

Type
PhaserComps.UIComponents.UIComponentPrototype

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:

removeChild(child)

Removes child from children list, and removes it from Phaser container instance, if one exists

Parameters:
Name Type Description
child PhaserComps.UIComponents.UIComponentPrototype

child component to remove
Returns:

returns child param

Type
PhaserComps.UIComponents.UIComponentPrototype

<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: