Simple label

Introduction¶

Using plain object to create label.

Author: Rex
Game object

Live demos¶

Usage¶

Sample code

Install plugin¶

Load minify file¶

Load plugin (minify file) in preload stage

scene.load.scenePlugin('rexuiplugin', 'https://raw.githubusercontent.com/rexrainbow/phaser3-rex-notes/master/dist/rexuiplugin.min.js', 'rexUI', 'rexUI');

Add label object

var label = scene.rexUI.add.simpleLabel(style).resetDisplayContent(config);
//var label = scene.rexUI.add.simpleLabel(style, creators).resetDisplayContent(config);

Import plugin¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Install plugin in configuration of game

import UIPlugin from 'phaser3-rex-plugins/templates/ui/ui-plugin.js';
var config = {
    // ...
    plugins: {
        scene: [{
            key: 'rexUI',
            plugin: UIPlugin,
            mapping: 'rexUI'
        },
        // ...
        ]
    }
    // ...
};
var game = new Phaser.Game(config);

Add label object

var label = scene.rexUI.add.simpleLabel(style).resetDisplayContent(config);
//var label = scene.rexUI.add.simpleLabel(style, creators).resetDisplayContent(config);

Import class¶

Install rex plugins from npm
```
npm i phaser3-rex-plugins
```

Import class

import { SimpleLabel } from 'phaser3-rex-plugins/templates/ui/ui-components.js';

Add label object

var label = new SimpleLabel(scene, style);
// var label = new SimpleLabel(scene, style, creators);
scene.add.existing(label);
label.resetDisplayContent(config)

Add label object¶

var label = scene.rexUI.add.simpleLabel({
    // x: 0,
    // y: 0,
    // anchor: undefined,
    // width: undefined,
    // height: undefined,

    orientation: 0,
    // rtl: false,

    // States-Round-rectangle background
    background: {...},

    // Nine-slice background
    background: {
        key: ,
        frame: ,
        leftWidth: , 
        rightWidth: ,
        topHeight: , 
        bottomHeight: 
    }

    // States-Image
    icon: {...},

    // iconMask: false,
    // squareFitIcon: false,
    // iconSize: undefined, iconWidth: undefined, iconHeight: undefined,

    // States-Text
    text: {...},
    // text: {
    //     $type: 'text',
    //     ...
    // }

    // Create bbcodetext
    // text: {
    //     $type: 'bbcodetext',
    //     ...
    // },

    // Create bitmaptext
    // text: {
    //     $type: 'bitmaptext',
    //     key: '',
    //     size: undefined,
    //     color: undefined,
    // },

    // wrapText: false,

    // expandTextWidth: false,
    // expandTextHeight: false,

    // States-Image
    action: {...},

    // squareFitAction: false,
    // actionMask: false,
    // actionSize: undefined, actionWidth: undefined, actionHeight: undefined,

    space: {
        left: 0, right: 0, top: 0, bottom:0, 
        icon: 0, text: 0
    }

    align: undefined,  // 'left' | 'top' | 'right' | 'bottom' | 'center

    // name: '',
    // draggable: false,
    // sizerEvents: false,
    // enableLayer: false,
}, creators);

background :

States-round-rectangle

Nine-slice

{
    key: ,
    frame: ,
    leftWidth: , 
    rightWidth: ,
    topHeight: , 
    bottomHeight: 
}

icon :
- States-Image

text :

States-Text, default type of game object.

{
    // $type: 'text',
    // more style setting...
}

Style of bbcodetext

{
    // $type: 'bbcodetext',  // or 'bbcode'
    // more style setting...
}

Style of bitmaptext

{
    // $type: 'bitmaptext',  // or 'bitmap'
    key: '',
    size: undefined,
    color: undefined,
}

wrapText : Enable WrapExpandText feature.
- false, 0 : No WrapExpandText feature. Default behavior.
- true, 1, 'word' : Word WrapExpandText.
- 2, 'char' : Character WrapExpandText.
action :
- States-Image
creators : A series of callback to create background, text, icon, action icon game object.
- creators.background : Callback to create background. Default behavior is creating a states round rectangle.
```
function(scene, config)  {
    return gameObject;
}
```
- creators.text : Callback to create text. Default behavior is creating a bbcodetext.
```
function(scene, config)  {
    return gameObject;
}
```
- creators.icon : Callback to create icon. Default behavior is creating a image.
```
function(scene, config)  {
    return gameObject;
}
```
- creators.action : Callback for creating action-icon. Default behavior is creating a image.
```
function(scene, config)  {
    return gameObject;
}
```

Custom class¶

Define class

class MyLabel extends RexPlugins.UI.SimpleLabel {
    constructor(scene, config, creators) {
        super(scene, config, creators);
        // ...
        scene.add.existing(this);
    }
    // ...
}

Create instance

var label = new MyLabel(scene, config, creators);

Reset display content¶

See label

Layout children¶

Arrange position of all elements.

label.layout();

Set state¶

Override/restore properties of background game object.

Note

Assume that background game object is states round rectangle game object.)

Active state¶

Enable active state
```
label.setActiveState();
// label.setActiveState(true);
```
- Override properties of background declared in config with prefix 'active.' parameters.
Disable active state
```
label.setActiveState(false);
```
- Restore properties of background.

Hover state¶

Enable active state
```
label.setHoverState();
// label.setHoverState(true);
```
- Override properties of background declared in config with prefix 'hover.' parameters
Disable active state
```
label.setHoverState(false);
```
- Restore properties of background.

Disable state¶

Enable disable state
```
label.setDisableState();
// label.setDisableState(true);
```
- Override properties of background declared in config with prefix 'disable.' parameters
Disable disable state
```
label.setDisableState(false);
```
- Restore properties of background.

Other properties¶

See label, sizer object, base sizer object, container-lite.