Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

Properties

closeOnBackPressed: boolean
elementProvider: IElementProvider
elementView: ImageView
isBackgroundDirty: boolean
isForegroundDirty: boolean
layout: ViewGroup
class: Class<UIWindow>

Methods

  • addAdjacentWindow(window: UIWindow): void
  • Adds another window as adjacent window, so that several windows open at the same time. This allows to divide window into separate parts and treat them separately.

    Parameters

    • window: UIWindow

      another window to be added as adjacent

    Returns void

  • clone(): any
  • Returns any

  • close(): void
  • Closes window without container. Use only if the window was opened without container

    Returns void

  • debug(): void
  • equals(param0: any): boolean
  • Parameters

    • param0: any

    Returns boolean

  • finalize(): void
  • Returns void

  • forceRefresh(): void
  • frame(time: number): void
  • Called up to 66 times a second to update window's content

    Parameters

    • time: number

      current time in milliseconds

    Returns void

  • getClass(): Class<any>
  • Returns Class<any>

  • getProperty<T>(name: string): T
  • Gets custom property by its name. Custom properties can be used to store some values containing window's current state. Note that these properties are not saved between Inner Core launches

    Type Parameters

    • T

    Parameters

    • name: string

      custom property name

    Returns T

    value set by UI.Window.putProperty or null if no value was specified for this name

  • getScale(): number
  • hashCode(): number
  • Returns number

  • invalidateAllContent(): void
  • invalidateBackground(): void
  • invalidateDrawing(onCurrentThread: boolean): 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. Default value if false. Ensure you are in the UI thread if you pass true as the parameter

    Returns void

  • invalidateElements(onCurrentThread: boolean): void
  • Forces ui elements of the window to refresh

    Parameters

    • onCurrentThread: boolean

      if true, the elements will be refreshed immediately, otherwise refresh event will be posted. Default value if false. Ensure you are in the UI thread if you pass true as the parameter

    Returns void

  • invalidateForeground(): void
  • isBlockingBackground(): boolean
  • isDynamic(): boolean
  • Returns boolean

    true if the window can change its contents position

  • isInventoryNeeded(): boolean
  • Returns boolean

    true if the window has an inventory that should be updated

  • isNotFocusable(): boolean
  • isOpened(): boolean
  • Returns boolean

    true if the window is opened, false otherwise

  • isTouchable(): boolean
  • notify(): void
  • Returns void

  • notifyAll(): void
  • Returns void

  • onBackPressed(): boolean
  • Returns boolean

    whether the window can be closed on pressing back navigation button

  • open(): void
  • Opens window without container. It is usually mor

    Returns void

  • postBackgroundRefresh(): void
  • postElementRefresh(): void
  • postOpen(): void
  • preOpen(): void
  • putProperty<T>(name: string, value: T): void
  • Sets custom property value

    Type Parameters

    • T

    Parameters

    • name: string

      custom property name

    • value: T

      custom property value

    Returns void

  • removeAdjacentWindow(window: UIWindow): void
  • Removes adjacent window from the adjacent windows list

    Parameters

    • window: UIWindow

      another window that was added as adjacent

    Returns void

  • runCachePreparation(async: boolean): void
  • setAsGameOverlay(inGameOverlay: boolean): void
  • Allows window to be displayed as game overlay without blocking Minecraft sounds. Note that this drops window's FPS. Default value is false

    Parameters

    • inGameOverlay: boolean

      if true, the window is opened in PopupWindow to avoid blocking Minecraft sounds

    Returns void

  • setBackgroundColor(color: number): void
  • Set background color of window

    Parameters

    • color: number

      integer color value (you can specify it using hex value)

    Returns void

  • setBlockingBackground(blockingBackground: boolean): void
  • Specifies whether the window should darken and block background. Default value is false

    Parameters

    • blockingBackground: boolean

      pass true if you want the window to block background

    Returns void

  • setCloseOnBackPressed(val: boolean): void
  • Gives the property to be closed on pressing back navigation button to the given window

    Parameters

    • val: boolean

    Returns 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(enabled: boolean): void
  • Turns debug mode for the window on and off

    Parameters

    • enabled: boolean

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

    Returns void

  • setDynamic(dynamic: boolean): void
  • Parameters

    • dynamic: boolean

      specify true, if the window contains dynamic (animated) elements, false otherwise. By default all windows are dynamic. Make them static for better performance

    Returns void

  • setInventoryNeeded(inventoryNeeded: boolean): void
  • Parameters

    • inventoryNeeded: boolean

      specify true if the window requires player's inventory. Default value is false

    Returns void

  • Overrides style properties of the current style by the values specified in the style parameter

    Parameters

    • style: BindingSet

      js object where keys represent binding names and values represent texture gui names

    Returns void

  • Sets new style object as current window's style. If the new style is a different object then an old one, forces window invalidation

    Parameters

    Returns void

  • setTouchable(touchable: boolean): void
  • Specifies whether touch events should be handled by this window or passed to underlying windows (to the game). By default all windows are touchable

    Parameters

    • touchable: boolean

      pass true if the window should handle touch events, false otherwise

    Returns void

  • toString(): string
  • Returns string

  • updateWindowLocation(): void
  • wait(): void
  • wait(param0: number): void
  • wait(param0: number, param1: number): void
  • Returns void

  • Parameters

    • param0: number

    Returns void

  • Parameters

    • param0: number
    • param1: number

    Returns void

Generated using TypeDoc