1.0.0

gui/com.peco2282.devcore.gui/GuiContext

GuiContext

abstract class GuiContext(val rows: Int) : Gui

A context class that provides a more declarative DSL for building GUIs. This class also supports state management.

Example usage:

val gui = inventory(3, Component.text("My GUI")) {
    var counter by state(0)

    slot(SLOT_2_5) {
        icon(Material.DIAMOND)
        name(Component.text("Clicked $counter times"))
        onClick {
            counter++ // This automatically triggers update()
        }
    }
}
gui.open(player)

Inheritors

PaginatedGuiContext

Constructors

constructor(rows: Int)

Types

inner class GuiState<T>(initial: T)

Delegate class for GUI states.

Properties

lateinit var inventory: Inventory

The underlying Bukkit inventory managed by this GUI.

Functions

abstract fun build()

Builds the GUI. This is where you define slots and states.

override fun build(creator: GuiCreator)

Builds the GUI using the provided GuiCreator.

fun fill(material: Material, pickable: Boolean = false, creator: SlotCreator.() -> Unit = {})

Fills all slots in the GUI with a material.

fun fillBorder(material: Material, pickable: Boolean = false, creator: SlotCreator.() -> Unit = {})

Fills the border of the GUI with a material.

fun fillRect(s1: Slot, s2: Slot, material: Material, pickable: Boolean = false, creator: SlotCreator.() -> Unit = {})

Fills a rectangular area defined by two slots with a material.

fun fillRect(x1: Int, y1: Int, x2: Int, y2: Int, material: Material, pickable: Boolean = false, creator: SlotCreator.() -> Unit = {})

Fills a rectangular area of the GUI with a material.

fun open(player: Player)

Opens the GUI for the specified player.

fun slot(slot: Slot, creator: SlotCreator.() -> Unit)

Configures a slot by a Slot instance.

fun slot(slot: Int, creator: SlotCreator.() -> Unit)

Configures a slot by its raw index (0-indexed).

fun slot(x: Int, y: Int, creator: SlotCreator.() -> Unit)

Configures a slot by its X and Y coordinates (1-indexed).

fun <T> state(initial: T): GuiContext.GuiState<T>

Creates a state delegate for this GUI. Changing the state will automatically trigger update.

fun GuiContext.template(template: GuiContext.() -> Unit)

Includes another builder block as a template.

fun title(title: Component)

Sets the title of the GUI.

fun update()

Generates or updates the inventory based on the current configuration. This should be called whenever the GUI's state changes.