Interface Frame

interface Frame {
    beginItem(w: number, h: number): void;
    buildItemStyleSelector(name: string, state: null | string): string;
    endItem(): void;
    getInput(): Input;
    getLayout(): Layout;
    getNextItemWidth(): null | number;
    getPainter(): Painter;
    getRect(): Rect;
    getScale(): number;
    getSpacing(): Vector2;
    getStyle(): Style;
    isItemClicked(control: number): boolean;
    isItemDisabled(): boolean;
    isItemHovered(): boolean;
    isItemPressed(control: number): boolean;
    setMouseCursor(mouseCursor: number): void;
    showOnScreenKeyboard(title: string, text: string, maxTextLength: number): void;
    tryGetOnScreenKeyboardResult(): null | string;
}

Methods

beginItem buildItemStyleSelector endItem getInput getLayout getNextItemWidth getPainter getRect getScale getSpacing getStyle isItemClicked isItemDisabled isItemHovered isItemPressed setMouseCursor showOnScreenKeyboard tryGetOnScreenKeyboardResult

Methods

beginItem

  • beginItem(w, h): void

  • Parameters

    • w: number
    • h: number

    Returns void

buildItemStyleSelector

  • buildItemStyleSelector(name, state): string

  • Parameters

    • name: string
    • state: null | string

    Returns string

endItem

getInput

getLayout

getNextItemWidth

  • getNextItemWidth(): null | number

  • Returns null | number

getPainter

getRect

getScale

getSpacing

getStyle

isItemClicked

  • isItemClicked(control): boolean

  • Parameters

    • control: number

      0 - MouseLeftButton (default), 1 - MouseRightButton, 2 - MouseScrollWheelUp, 3 - MouseScrollWheelDown

    Returns boolean

isItemDisabled

isItemHovered

isItemPressed

  • isItemPressed(control): boolean

  • Parameters

    • control: number

      0 - MouseLeftButton (default), 1 - MouseRightButton, 2 - MouseScrollWheelUp, 3 - MouseScrollWheelDown

    Returns boolean

setMouseCursor

  • setMouseCursor(mouseCursor): void

  • Parameters

    • mouseCursor: number

    Returns void

showOnScreenKeyboard

  • showOnScreenKeyboard(title, text, maxTextLength): void

  • Parameters

    • title: string
    • text: string
    • maxTextLength: number

    Returns void

tryGetOnScreenKeyboardResult

  • tryGetOnScreenKeyboardResult(): null | string

  • Returns null | string

Settings

Member Visibility

On This Page

Methods