Package-level declarations

Contains the GUI builder and all GUI implementation classes

Types

Link copied to clipboard
class Gui(val guiType: GuiType, val title: Component, val pagesByKey: Map<String, GuiPage>, val pagesByNumber: Map<Int, GuiPage>, val defaultPageKey: String, val eventHandler: GuiEventHandler) : SimpleContainer, MenuProvider
Link copied to clipboard
Link copied to clipboard
class GuiBuilder(val type: GuiType, val title: Component, val defaultPageKey: Any)
Link copied to clipboard
class GuiCompound<E>(val guiType: GuiType, val slots: GuiSlotCompound.SlotRange.Rectangle, val content: AbstractGuiList<E, List<E>>, iconGenerator: suspend (E) -> ItemStack, onClick: suspend (event: GuiClickEvent, element: E) -> Unit?) : GuiUseable
Link copied to clipboard
data class GuiDimensions(val width: Int, val height: Int)
Link copied to clipboard
interface GuiElement
Link copied to clipboard
interface GuiEvent
Link copied to clipboard
class GuiEventHandler(val onClick: suspend (GuiClickEvent) -> Unit?, val onClose: suspend (GuiCloseEvent) -> Unit?)
Link copied to clipboard
abstract class GuiIcon : GuiUseable
Link copied to clipboard
class GuiPage(val key: String, val number: Int, val content: Map<Int, GuiElement>, val effectTo: GuiPage.ChangeEffect?, val effectFrom: GuiPage.ChangeEffect?) : GuiUseable
Link copied to clipboard
Link copied to clipboard
class GuiScreenHandler(val gui: Gui, syncId: Int, inventory: Inventory, container: Container) : ChestMenu
Link copied to clipboard
data class GuiSlot(val row: Int, val slotInRow: Int) : GuiSlotCompound, Comparable<GuiSlot>
Link copied to clipboard
interface GuiSlotCompound
Link copied to clipboard
Link copied to clipboard
abstract class GuiUseable
Link copied to clipboard
object Slots

Properties

Link copied to clipboard

Creates a static gui icon.

Functions

Link copied to clipboard
fun Gui.changePage(fromPage: GuiPage, toPage: GuiPage, overrideEffect: GuiPage.ChangeEffect? = null): Job
Link copied to clipboard
fun <E> GuiProperty<E>.guiIcon(iconGenerator: (E) -> ItemStack): GuiIcon.VariableIcon<E>

Creates a gui icon which automatically updates itself if the value of the property changes.

Link copied to clipboard

Creates a new slot range.

Link copied to clipboard
inline fun igui(type: GuiType, title: Component, defaultPageKey: Any, builder: GuiBuilder.() -> Unit): Gui

Creates a new gui.

Link copied to clipboard

Creates a new slot range.

Link copied to clipboard
fun ServerPlayer.openGui(gui: Gui, pageKey: Any? = null): Job

Opens the given gui.

Link copied to clipboard

Creates a new slot range.

Link copied to clipboard
infix fun Int.sl(slotInRow: Int): GuiSlot

Creates a new gui slot.