@petkoneo/phaser3-rex-plugins/templates/ui/tweaker/Tweaker.d.ts

Plugins of phaser3

import BaseSizer from '../basesizer/BaseSizer';
import Sizer from '../sizer/Sizer';
import RoundRectangle from '../roundrectangle/RoundRectangle';
import CreateBackground from '../utils/build/CreateBackground';
import SimpleLabel from '../simplelabel/SimpleLabel';
import Buttons from '../buttons/Buttons';
import FixWidthButtons from '../fixwidthbuttons/FixWidthButtons';
import Pages from '../pages/Pages';
import InputText from '../canvasinput/CanvasInput';
import InputTextArea from '../textareainput/TextAreaInput';
import Checkbox from '../checkbox/Checkbox';
import ToggleSwitch from '../toggleswitch/ToggleSwitch';
import ColorInput from '../colorinput/colorinput/ColorInput';

export default Tweaker;

declare namespace Tweaker {
    interface IInteractiveRoundRectangleConfig extends RoundRectangle.IConfig {
        'active.color'?: number,
        'active.alpha'?: number,

        'active.strokeColor'?: number,
        'active.strokeAlpha'?: number,
        'active.strokeWidth'?: number,
    }

    interface IInteractiveLabelConfig extends SimpleLabel.IConfig {
        background?: IInteractiveRoundRectangleConfig,
    }

    interface IButtonConfig extends IInteractiveLabelConfig {
        expand?: boolean,
    }

    interface IIncDecConfig {
        incButton?: SimpleLabel.IConfig,
        decButton?: SimpleLabel.IConfig,
        inputTextIndex?: 0 | 1 | 2
    }

    interface IFolderTitleConfig extends SimpleLabel.IConfig {
        expandedIcon?: {
            color?: number,
            alpha?: number,

            strokeColor?: number,
            strokeAlpha?: number,
            strokeWidth?: number,
            arrowOnly?: boolean,

            easeDuration?: number,
        }
    }

    interface IInputRowStyle {
        background?: CreateBackground.IConfig,

        title?: SimpleLabel.IConfig,

        inputText?: InputText.IConfig,

        inputTextArea?: InputTextArea.IConfig,

        slider?: {
            track: RoundRectangle.IConfig,
            indicator: RoundRectangle.IConfig,
            thumb: RoundRectangle.IConfig,
        },

        list?: {
            label?: SimpleLabel.IConfig,

            button?: IInteractiveLabelConfig,
        },

        button?: IButtonConfig,

        checkbox?: Checkbox.IConfig,

        toggleSwitch?: ToggleSwitch.IConfig,

        colorInput?: ColorInput.IConfig,

        incDec?: IIncDecConfig,

        proportion?: {
            title?: number,
            inputField?: number,
            range?: {
                slider?: number,
                inputText?: number,
            }
        }
    }

    interface IOptionConfig extends SimpleLabel.IResetDisplayContentConfig {
        value: any
    }

    interface IStyle {
        itemWidth?: number,
        itemHeight?: number,

        background?: CreateBackground.IConfig,

        inputRow?: IInputRowStyle,

        folder?: {
            title?: SimpleLabel.IConfig,

            background?: CreateBackground.IConfig,

            space?: {
                left?: number, right?: number, top?: number, bottom?: number,
                item?: number
            },
        },

        tab?: {
            tab?: IInteractiveLabelConfig,

            wrapTabs?: boolean,
            tabs?: Buttons.IConfig | FixWidthButtons.IConfig,
            pages?: Pages.IConfig,
        },

        columns?: {
            title?: SimpleLabel.IConfig,

            background?: CreateBackground.IConfig | CreateBackground.IConfig[],

            space?: {
                left?: number, right?: number, top?: number, bottom?: number,
                column?: number,
                title?: number,
            }
        },

        wrap?: {
            itemWidth?: number,

            title?: SimpleLabel.IConfig,

            background?: CreateBackground.IConfig | CreateBackground.IConfig[],

            space?: {
                left?: number, right?: number, top?: number, bottom?: number,
                item?: number, line?: number,
                title?: number,
            }
        }

        scrollable?: {
            title?: SimpleLabel.IConfig,

            background?: CreateBackground.IConfig,

            slider?: {
                track: CreateBackground.IConfig,
                thumb: CreateBackground.IConfig,

                hideUnscrollableSlider?: boolean,
                disableUnscrollableDrag?: boolean,
                adaptThumbSize?: boolean,
                minThumbSize?: number,
            },

            space?: {
                panel?: number
            },
        },

        separator?: RoundRectangle.IConfig,

        space?: {
            left?: number, right?: number, top?: number, bottom?: number,
            item?: number
        }
    }

    interface IConfig extends Sizer.IConfig {
        styles: IStyle,
        style: IStyle,
    }

    interface IAddInputConfig {
        bindingTarget?: Object,
        bindingKey?: string,
        autoUpdate?: boolean,

        onGetValue?: (bindingTarget: Object) => unknown,
        onSetValue?: (bindingTarget: Object, value: undefined) => void,

        view?: string,

        icon?: string,
        iconFrame?: string,
        iconSize?: number,

        title?: string,

        orientation?: Sizer.OrientationTypes,

        // range, incdec
        min?: number, max?: number, step?: number,

        // list, buttons
        options?: IOptionConfig[],

        format: (value?: any) => string,

        inputTextReadOnly?: boolean,

        monitor?: boolean,

        key?: string,

        onValidate?: (
            newValue: any, oldValue: any,
            bindingTarget: Object, bindingKey: string
        ) => boolean;

        onValueChange?: (
            newValue: any, oldValue: any,
            bindingTarget: Object, bindingKey: string
        ) => void,
    }

    interface IAddButtonConfig {
        bindingTarget?: Object,

        icon?: string,
        iconFrame?: string,
        iconSize?: number,

        title: string,

        label: string | SimpleLabel.IResetDisplayContentConfig,
        callback: (bindingTarget: Object) => void,

        key?: string,
    }

    interface IAddButtonsConfig {
        bindingTarget?: Object,

        icon?: string,
        iconFrame?: string,
        iconSize?: number,

        title: string,

        buttons: {
            label: string | SimpleLabel.IResetDisplayContentConfig,
            callback: (bindingTarget: Object) => void,
        }[],

        wrap?: boolean,

        key?: string,
    }

    interface IAddTabConfig {
        pages: {
            title: string,
            show?: boolean,

            key?: string,
        }[]
    }

    interface IAddFolderConfig {
        title: string,
        expanded?: boolean,

        key?: string,
    }

    interface IAddColumnsConfig {
        title?: string,

        columns?: {
            width?: number,
            expand?: boolean,

            key?: string,
        }[]
    }

    interface IAddWrapConfig {
        title: string,
        itemWidth?: number,
        itemHeight?: number,

        key?: string,
    }


    interface IAddScrollableConfig {
        title?: string,
        height?: string

        key?: string,
    }

    interface IAddInputRowProperty extends IAddInputConfig {
        $key: string
    }

    interface IAddFolderRowProperty extends IAddFolderConfig {
        $type: 'folder',
        $target?: Object,
        $properties: RowsPropertyType[]
    }

    interface IAddTabRowProperty extends IAddTabConfig {
        $type: 'tab',
        $target?: Object,
        pages: {
            title: string,
            show?: boolean,

            key?: string,

            $properties: RowsPropertyType[]
        }[]
    }

    interface IAddColumnsRowProperty extends IAddColumnsConfig {
        $type: 'columns',
        $target?: Object,
        columns: {
            width?: number,

            expand?: boolean,

            key?: string,

            $properties: RowsPropertyType[]
        }[]
    }

    interface IAddWrapRowProperty extends IAddWrapConfig {
        $type: 'wrap',
        $target?: Object,
        $properties: RowsPropertyType[]
    }

    interface IAddScrollableRowProperty extends IAddScrollableConfig {
        $type: 'scrollable',
        $target?: Object,
        $properties: RowsPropertyType[]
    }

    interface IAddSeparatorRowProperty {
        $type: 'separator',
    }

    interface IAddButtonRowProperty extends IAddButtonConfig {
        $type: 'button',
    }

    interface IAddButtonsRowProperty extends IAddButtonsConfig {
        $type: 'buttons',
    }

    type RowsPropertyType = IAddInputRowProperty |
        IAddFolderRowProperty | IAddTabRowProperty | IAddColumnsRowProperty | IAddScrollableRowProperty |
        IAddSeparatorRowProperty | IAddButtonRowProperty | IAddButtonsRowProperty;

    interface IAcceptConfig extends IAddInputConfig {
        value: unknown
    }

    interface IInputHandlerConfig {
        name?: string,

        baseClass?: BaseSizer,

        accept: (
            config: IAcceptConfig,
        ) => boolean,

        build: (
            gameObject: BaseSizer,
            style: IInputRowStyle
        ) => void,

        setup?: (
            gameObject: BaseSizer,
            config: IAddInputConfig,
            setDefaults: boolean,
        ) => void,

        displayValue?: (
            gameObject: BaseSizer,
            value: unknown
        ) => void,

    }

}

declare class Tweaker extends Sizer {
    constructor(
        scene: Phaser.Scene,
        config?: Tweaker.IConfig
    );

    registerInputHandler(
        config: Tweaker.IInputHandlerConfig
    ): this;

    removeInputHandler(
        name: string
    ): this;

    addInput(
        object: Object,
        key: string,
        config?: Tweaker.IAddInputConfig
    ): this;

    addInput(
        config?: Tweaker.IAddInputConfig
    ): this;

    addButton(
        config: Tweaker.IAddButtonConfig
    ): this;

    addButtons(
        config: Tweaker.IAddButtonsConfig
    ): this;

    addSeparator(): this;

    addFolder(
        config: Tweaker.IAddFolderConfig
    ): Tweaker;

    addTab(
        config: Tweaker.IAddTabConfig
    ): Tweaker[];

    addColumns(
        config: number | Tweaker.IAddColumnsConfig
    ): Tweaker[];

    addWrap(
        config: Tweaker.IAddWrapConfig
    ): Tweaker;

    addScrollable(
        config: Tweaker.IAddScrollableConfig
    ): Tweaker;

    addRows(
        properties: Tweaker.RowsPropertyType[],
        target?: Object,
        monitor?: boolean,
    ): this;

    addRows(
        properties: Tweaker.RowsPropertyType[],
        monitor?: boolean,
    ): this;

    setBindingTarget(
        object: Object
    ): this;
}