UI / StaleButton

StaleButton Class ​

Text button

Usage example: create a script named "NewScript", place it in the object sub level of the object manager, open the script, enter the following code to save it, run the game, and a button will be displayed on the screen.

@Component
export default class NewScript extends Script {

    protected onStart(): void {
        if(SystemUtil.isClient()){
            if(SystemUtil.isClient()){
                let mainui = UIService.create(UI_Main);
                UIService.showUI(mainui);
                UIService.canvas.addChild(mainui.button);
            }
        }
    }
}
class UI_Main extends UIScript {

    button: StaleButton = undefined;

    public onAwake() {
        let size = WindowUtil.getViewportSize();

        this.button = StaleButton.newObject();
        this.button.transform = new UITransform(size.x/2,size.y/2,size.x / 14, size.y / 20);

        this.button.size = new Vector2(size.x / 14, size.y / 20);
        this.button.text = "StaleButton";
        this.button.fontSize = 18;
        this.button.transitionEnable = true;
        InputUtil.bindButton(Keys.X, this.button);
        this.button.setPressedImageColorDecimal(200, 200, 200, 255);
        this.button.onClicked.add(() => {
            // When the button is pressed, execute the following logic
            console.log("The \"StaleButton\" button was pressed ~");
        });
    }
}

@Component
export default class NewScript extends Script {

    protected onStart(): void {
        if(SystemUtil.isClient()){
            if(SystemUtil.isClient()){
                let mainui = UIService.create(UI_Main);
                UIService.showUI(mainui);
                UIService.canvas.addChild(mainui.button);
            }
        }
    }
}
class UI_Main extends UIScript {

    button: StaleButton = undefined;

    public onAwake() {
        let size = WindowUtil.getViewportSize();

        this.button = StaleButton.newObject();
        this.button.transform = new UITransform(size.x/2,size.y/2,size.x / 14, size.y / 20);

        this.button.size = new Vector2(size.x / 14, size.y / 20);
        this.button.text = "StaleButton";
        this.button.fontSize = 18;
        this.button.transitionEnable = true;
        InputUtil.bindButton(Keys.X, this.button);
        this.button.setPressedImageColorDecimal(200, 200, 200, 255);
        this.button.onClicked.add(() => {
            // When the button is pressed, execute the following logic
            console.log("The \"StaleButton\" button was pressed ~");
        });
    }
}

Hierarchy ​

• Widget

  ↳ StaleButton

Table of contents ​

Properties ​

Accessors ​

Methods ​

Properties ​

Accessors ​

clickMethod ​

contentColor ​

disableImageColor ​

disableImageDrawType ​

disableImageGuid ​

disableImageInfo ​

disableImageMargin ​

disableImageSize ​

focusable ​

fontColor ​

fontLetterSpace ​

fontSize ​

glyph ​

normalImageColor ​

normalImageDrawType ​

normalImageGuid ​

normalImageInfo ​

normalImageMargin ​

normalImageSize ​

onClicked ​

onHovered ​

onPressed ​

onReleased ​

onUnhovered ​

outlineColor ​

outlineSize ​

pressMethod ​

pressedImagColor ​

pressedImageDrawType ​

pressedImageGuid ​

pressedImageInfo ​

pressedImageMargin ​

pressedImageSize ​

shadowColor ​

shadowOffset ​

strikethroughEnable ​

text ​

textAlign ​

textVerticalAlign ​

touchMethod ​

transitionEnable ​

underlineEnable ​

Methods ​

addKey ​

• addKey(key): void other

The same button can only control one UI control at a time, and the latest bound UI control will overwrite the previous binding; The binding added in the script cannot override the UI controls bound to the same key in the editor's key binding menu. However, when two UI controls are bound to the same key separately through code and menu, the priority of using code binding is higher

Parameters ​

getKeys ​

• getKeys(): Keys[] other

Get all the keyboard keys bound to the current UI widget, including the editor key binding menu and the code bound keys

Returns ​

isPressed ​

• isPressed(): boolean other

Whether press

Returns ​

removeKey ​

• removeKey(key): void other

This operation only unbinds dynamically bound keys and cannot unbind keys bound in the editor's key binding menu

Parameters ​

setButtonDisableByFile ​

• setButtonDisableByFile(absPath, bRefreshCache?): void other

Set unavailable image

Parameters ​

setButtonNormalByFile ​

• setButtonNormalByFile(absPath, bRefreshCache?): void other

Set normal image

Parameters ​

setButtonPressedByFile ​

• setButtonPressedByFile(absPath, bRefreshCache?): void other

Set press image

Parameters ​

setDisableImageColorByHex ​

• setDisableImageColorByHex(inHexString): void other

Set unavailable color to specify Hex's color text, set color # 05050505

Parameters ​

setDisableImageColorDecimal ​

• setDisableImageColorDecimal(R, G, B, A): void other

Set unavailable colors

Parameters ​

setFontColorByHex ​

• setFontColorByHex(inHexString): void other

Set font color, specify the color of Hex text Set Color # 05050505

Parameters ​

setFontColorDecimal ​

• setFontColorDecimal(R, G, B, A): void other

Set font color

Parameters ​

setNormalImageColorByHex ​

• setNormalImageColorByHex(inHexString): void other

Set normal color, specify Hex's color text, set color # 05050505

Parameters ​

setNormalImageColorDecimal ​

• setNormalImageColorDecimal(R, G, B, A): void other

Set normal color

Parameters ​

setPressedImageColorByHex ​

• setPressedImageColorByHex(inHexString): void other

Set press Color to specify the color of Hex text Set Color # 05050505

Parameters ​

setPressedImageColorDecimal ​

• setPressedImageColorDecimal(R, G, B, A): void other

Set press color

Parameters ​

newObject ​

• Static newObject(parent?, inName?): StaleButton other

Create StaleButton control

Parameters ​

Returns ​

When the parent and inName are the same as an existing object, the old object will be destroyed