Interface IWindow

interface IWindow {
    close(): void;
    frame(time: number): void;
    getContainer(): UiAbstractContainer;
    getContent(): WindowContent;
    getElements(): HashMap<string, IElement>;
    getStyle(): Style;
    invalidateDrawing(onCurrentThread: boolean): void;
    invalidateElements(onCurrentThread: boolean): void;
    isDynamic(): boolean;
    isInventoryNeeded(): boolean;
    isOpened(): boolean;
    onBackPressed(): boolean;
    open(): void;
    setContainer(container: UiAbstractContainer): void;
    setDebugEnabled(debug: boolean): void;
}

Implemented by

Methods

close frame getContainer getContent getElements getStyle invalidateDrawing invalidateElements isDynamic isInventoryNeeded isOpened onBackPressed open setContainer setDebugEnabled

Methods

close

  • close(): void

  • Closes window without container. Use only if the window was opened without container.

    Returns void

frame

  • frame(time): void

  • Called up to 66 times a second to update window's content.

    Parameters

    • time: number

      current time in milliseconds

    Returns void

getContainer

getContent

getElements

getStyle

invalidateDrawing

  • invalidateDrawing(onCurrentThread): void

  • Forces ui drawables of the window to refresh.

    Parameters

    • onCurrentThread: boolean

      if true, the drawables will be refreshed immediately, otherwise refresh event will be posted; ensure you are in the UI thread if you pass true as the parameter

    Returns void

    Default

    onCurrentThread: false

invalidateElements

  • invalidateElements(onCurrentThread): void

  • Forces ui elements of the window to refresh.

    Parameters

    • onCurrentThread: boolean

      if true, the drawables will be refreshed immediately, otherwise refresh event will be posted; ensure you are in the UI thread if you pass true as the parameter

    Returns void

    Default

    onCurrentThread: false

isDynamic

  • isDynamic(): boolean

  • Returns boolean

    true if the window can change it's contents position.

isInventoryNeeded

  • isInventoryNeeded(): boolean

  • Returns boolean

    true if the window has an inventory that should be updated.

isOpened

  • isOpened(): boolean

  • Returns boolean

    true if the window is opened, false otherwise.

onBackPressed

  • onBackPressed(): boolean

  • Returns boolean

    Whether the window can be closed on pressing back navigation button.

open

setContainer

  • setContainer(container): void

  • Sets container for the current window. Be careful when calling it manually. You should prefer opening the window via UI.Container.openAs call.

    Parameters

    Returns void

setDebugEnabled

  • setDebugEnabled(debug): void

  • Turns debug mode for the window on and off.

    Parameters

    • debug: boolean

      if true, additional debug information will be drawn on the window canvas

    Returns void

Settings

Member Visibility

On This Page

Methods

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.