gui/com.peco2282.devcore.gui/PaginatedGuiContext

PaginatedGuiContext

abstract class PaginatedGuiContext<T>(val rows: Int) : GuiContext

A context class for GUIs that support pagination.

Parameters

rows

The number of rows in the GUI.

Constructors

PaginatedGuiContext

constructor(rows: Int)

Properties

currentPage

var currentPage: Int

The current page index (0-indexed).

inventory

lateinit var inventory: Inventory

The underlying Bukkit inventory managed by this GUI.

items

var items: List<T>

The list of items to be paginated.

pageSize

var pageSize: Int

The number of items to display per page.

rows

val rows: Int

totalPages

val totalPages: Int

The total number of pages.

Functions

build

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.

content

fun content(slots: List<Int>, display: SlotCreator.(T) -> Unit)

DSL for defining how to display each item in the list.

fun content(range: IntRange, display: SlotCreator.(T) -> Unit)

DSL for defining how to display each item in the list using a range of slots.

fill

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

Fills all slots in the GUI with a material.

fillBorder

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

Fills the border of the GUI with a material.

fillRect

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 nextPage()

Goes to the next page.

open

fun open(player: Player)

Opens the GUI for the specified player.

fun prevPage()

Goes to the previous page.

slot

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).

state

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

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

template

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

Includes another builder block as a template.

title

fun title(title: Component)

Sets the title of the GUI.

update

fun update()

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