phaser4-rex-plugins/templates/ui/knob/Knob.d.ts

Plugins of phaser4

// import * as Phaser from 'phaser';
import OverlapSizer from '../overlapsizer/OverlapSizer';


export default Knob;

declare namespace Knob {

    type InputTypes = 0 | 1 | -1 | 'drag' | 'pan' | 'click' | 'none';

    interface IConfig extends OverlapSizer.IConfig {
        background?: Phaser.GameObjects.GameObject,

        barColor?: number | string,
        trackColor?: number | string,
        centerColor?: number | string,
        thickness?: number,
        startAngle?: number,
        anticlockwise?: boolean,
        knobDepth?: number,

        text?: Phaser.GameObjects.GameObject,
        textFormatCallback?: (value: number) => string,
        textFormatCallbackScope?: object,

        input?: InputTypes,

        value?: number,

        gap?: number,

        easeValue?: {
            duration?: number,
            ease?: string
        },

        valuechangeCallback: (newValue: number, oldValue: number, knob: Knob) => void,

        enable?: boolean,

    }

}

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

    value: number;
    getValue(min?: number, max?: number): number;
    setValue(value?: number, min?: number, max?: number): this;
    addValue(inc?: number, min?: number, max?: number): this;

    easeValueTo(value?: number, min?: number, max?: number): this;
    stopEaseValue(): this;
    setEaseValueDuration(duration: number): this;
    setEaseValueFunction(ease: string): this;

    setEnable(enable?: boolean): this;
    enable: boolean;
}