Tile Entity Menu¶

Nova's TileEntity class has a menu: TileEntityMenu property which is used to manage this windows associated with the tile entity. Simply override it to add a GUI to your tile entity:

override val menu = TileEntityMenu.cachedWindow(GuiTextures.EXAMPLE_GUI_TEXTURE) { // (1)!
    // (2)!
    upperGui by /* ... */
}

1. TileEntityMenu.cachedWindow is recommended. The TileEntityMenu will remember the opened window, which prevents unnecessary re-creation and also prevents gui state (e.g. for PagedGui) from being forgotten immediately on close. You can, however, also use TileEntityMenu.window for an uncached window.

   Additionally, you can also specify the type of WindowDsl to use, for example if you want to use an AnvilWindow instead.

2. This is a standard WindowDsl.() -> Unit block (like window(player)). Each player will get their own Window.

Make sure that you have the TileEntityInteractive block behavior applied, otherwise the tile entity will not receive the click action and no menu will be opened.

Tracking additional Windows¶

The TileEntityMenu needs to be made aware of any additional windows, so that it can close them when the tile entity is destroyed or when the viewer moves out of range. You can do this by calling TileEntityMenu.register(Window).

context(tileEntity: TileEntity, windowDsl: WindowDsl) // (1)!
fun openSubWindow(): Item = item {
    itemProvider by GuiItems.OPEN_EXAMPLE_WINDOW_BTN

    val exampleWindow by lazy {
        val window = createExampleWindow(windowDsl.viewer, windowDsl.window) // (2)!
        tileEntity.menu.register(window) // (3)!
        window
    }

    onClick {
        exampleWindow.open()
    }
}