melonJS
    Preparing search index...

    Interface VirtualButton

    A button, pressed while a finger is on it.

    interface VirtualButton {
        area: ControlArea;
        button: number | null;
        center: { x: number; y: number };
        floating: boolean;
        hideAtRest: boolean;
        radius: number;
        get dimmed(): boolean;
        set dimmed(value: boolean): void;
        get label(): string;
        set label(value: string): void;
        get pressed(): boolean;
        get visible(): boolean;
        set visible(value: boolean): void;
        covers(x: number, y: number, width: number, height: number): boolean;
        destroy(): void;
        draw(renderer: Renderer, look: Look): void;
        frameEnd(): void;
        frameStart(): void;
        hits(x: number, y: number, width?: number, height?: number): boolean;
        layout(width: number, height: number, margin: number, floor: number): void;
        press(pointerId: number, x?: number, y?: number): void;
        release(pointerId: number): void;
        releaseAll(): void;
        restDistance(x: number, y: number): number;
    }
    Index
    area button center floating hideAtRest radius
    dimmed label pressed visible
    covers destroy draw frameEnd frameStart hits layout press release releaseAll restDistance
    area: ControlArea

    where a floating button can be pressed

    button: number | null

    the pad button it presses, or null

    center: { x: number; y: number } = ...

    where its center is, in viewport pixels: under the finger while a floating button is held

    floating: boolean

    whether it is pressed wherever a finger lands in its area

    hideAtRest: boolean

    whether a floating button is drawn only while held

    radius: number = 0

    its radius, in viewport pixels

    • whether a point is in a floating button's area, held or not

      Parameters

      • x: number

        in viewport pixels

      • y: number

        in viewport pixels

      • width: number

        the viewport width, in pixels

      • height: number

        the viewport height, in pixels

      Returns boolean

    • whether a finger landing here presses it

      Parameters

      • x: number

        in viewport pixels

      • y: number

        in viewport pixels

      • width: number = 0

        the viewport width, in pixels, for a floating button

      • height: number = 0

        the viewport height, in pixels, for a floating button

      Returns boolean

    • place it in a viewport of this size, above floor (the right stick)

      Parameters

      • width: number

        the viewport width, in pixels

      • height: number

        the viewport height, in pixels

      • margin: number

        the space kept from the edges

      • floor: number

        the height taken by a right stick below the buttons

      Returns void

    • Parameters

      • pointerId: number

        the pointer

      • Optionalx: number

        where it landed, in viewport pixels: a floating button moves under it

      • Optionaly: number

        where it landed, in viewport pixels

      Returns void

    • how far a point is from where the button rests, in viewport pixels

      Parameters

      • x: number

        in viewport pixels

      • y: number

        in viewport pixels

      Returns number

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods