Interface CCWindowManagerFramebuffer

The CCWindowManagerFramebuffer interface represents the underlying framebuffer that is used as a render target for a window. It contains methods similar to a CraftOS window, but with additional methods relating to window ordering and other window manager-specific tasks. This type can only be constructed through a CCWindowManagerConnection instance.

interface CCWindowManagerFramebuffer {
    blit(text: string, fg: string, bg: string): void;
    clear(): void;
    clearLine(): void;
    close(): void;
    getBackgroundColor(): number;
    getBackgroundColour(): number;
    getBorderColor(): number;
    getCursorBlink(): boolean;
    getCursorPos(): LuaMultiReturn<[number, number]>;
    getLine(y: number): LuaMultiReturn<[] | [string, string, string]>;
    getPaletteColor(color: number): LuaMultiReturn<[number, number, number]>;
    getPaletteColour(color: number): LuaMultiReturn<[number, number, number]>;
    getPosition(): LuaMultiReturn<[number, number]>;
    getSize(): LuaMultiReturn<[number, number]>;
    getTextColor(): number;
    getTextColour(): number;
    gfxHandle(): CCWindowManagerGraphicsFramebuffer;
    isColor(): boolean;
    isColour(): boolean;
    isVisible(): boolean;
    redraw(): void;
    reposition(x: number, y: number): void;
    resize(w: number, h: number): void;
    restoreCursor(): void;
    scroll(lines: number): void;
    sendBack(): void;
    sendFront(): void;
    sendFrontAndFocus(): void;
    setBackgroundColor(color: number): void;
    setBackgroundColour(color: number): void;
    setBorderColor(color: number): void;
    setCursorBlink(blink: boolean): void;
    setCursorPos(x: number, y: number): void;
    setPaletteColor(color: number, rgb: number): void;
    setPaletteColor(color: number, r: number, g: number, b: number): void;
    setPaletteColour(color: number, rgb: number): void;
    setPaletteColour(color: number, r: number, g: number, b: number): void;
    setTextColor(color: number): void;
    setTextColour(color: number): void;
    setTitle(title: string): void;
    setVisible(visible: boolean): void;
    write(text: string): void;
}

Methods

  • Parameters

    • y: number

    Returns LuaMultiReturn<[] | [string, string, string]>

  • Parameters

    • color: number

    Returns LuaMultiReturn<[number, number, number]>

  • Parameters

    • color: number

    Returns LuaMultiReturn<[number, number, number]>

  • Parameters

    • color: number
    • rgb: number

    Returns void

  • Parameters

    • color: number
    • r: number
    • g: number
    • b: number

    Returns void

  • Parameters

    • color: number
    • rgb: number

    Returns void

  • Parameters

    • color: number
    • r: number
    • g: number
    • b: number

    Returns void