igf/net.ririfa.igf/PaginatedDynamicGUI

PaginatedDynamicGUI

class PaginatedDynamicGUI<S : Enum<S>>(enumClass: Class<S>, player: Player) : InventoryGUI

A generic class used to create a paginated GUI in Minecraft, allowing dynamic switching between pages and states mapped to an enum type. It supports custom item mappings, navigation buttons, and empty state messages to provide a flexible inventory GUI system.

Parameters

the enum type for state management must extend Enum

enumClass

the class of the enum used for managing GUI states

player

the player associated with the GUI

Constructors

PaginatedDynamicGUI

constructor(enumKClass: KClass<S>, player: Player)

Constructs a PaginatedDynamicGUI instance by delegating the given enumKClass and player to another constructor.

constructor(enumClass: Class<S>, player: Player)

Types

Companion

object Companion

A companion object for the PaginatedDynamicGUI class. Provides a utility function to create an instance of the PaginatedDynamicGUI for a given Enum class and player.

Properties

currentPage

var currentPage: Int

currentState

var currentState: S?

emptyMessageButton

var emptyMessageButton: Button?

items

var items: List<Button>

Represents the list of buttons to be displayed in this inventory GUI. Each button corresponds to a slot and can define its own material, name, custom data, and click behavior.

itemsPerPage

var itemsPerPage: Int

onCloseFunc

var onCloseFunc: (PaginatedDynamicGUI<S>) -> Unit?

pageChangeButtons

var pageChangeButtons: Pair<Button, Button>?

pageItems

var pageItems: List<Button>

paginationEnabledStates

var paginationEnabledStates: Set<S>

slotPositions

var slotPositions: List<Int>

statePageItemProvider

var statePageItemProvider: (S) -> List<Button>?

totalPages

var totalPages: Int

Functions

addItem

fun addItem(button: Button): InventoryGUI

Adds a single item to the existing item list.

build

open override fun build(): InventoryGUI

Constructs and prepares the InventoryGUI object for use by setting the appropriate state and displaying it. If the currentState is null and the enumClass corresponds to SinglePage, it initializes currentState with SinglePage.PAGE.

fun close()

Closes the inventory for the player.

getAllButtons

open override fun getAllButtons(): List<Button>

getBackgroundMaterial

fun getBackgroundMaterial(): Material?

Gets the background material set for the inventory GUI.

getInventory

open override fun getInventory(): Inventory

Returns the inventory associated with this GUI.

getListener

fun getListener(): GUIListener?

Gets the current listener associated with this GUI.

getSize

fun getSize(): Int?

Gets the size of the inventory GUI.

getTitle

fun getTitle(): Component?

Gets the title of this GUI.

fun nextPage()

onClose

fun onClose(block: (PaginatedDynamicGUI<S>) -> Unit): PaginatedDynamicGUI<S>

Sets a handler to be called when this GUI is closed.

open

fun open()

Opens the inventory for the player.

fun prevPage()

setBackground

fun setBackground(background: Material): InventoryGUI

Sets the background material for the inventory GUI.

setEmptyMessageButton

fun setEmptyMessageButton(button: Button): PaginatedDynamicGUI<S>

Sets the button to be displayed when the paginated GUI has no items to show.

setItems

fun setItems(items: List<Button>): InventoryGUI

Sets multiple items at once for the GUI. This replaces the existing item list.

setItemsPerPage

fun setItemsPerPage(count: Int): PaginatedDynamicGUI<S>

Sets the number of items that should be displayed per page in the GUI.

setListener

fun ~~setListener~~(listener: GUIListener): InventoryGUI

Sets the listener for handling GUI events.

setPageChangeButtons

fun setPageChangeButtons(prev: Button, next: Button): PaginatedDynamicGUI<S>

Sets the buttons used to navigate between pages in the paginated GUI. The provided buttons will be assigned click actions to move to the previous or next page.

setPageItemProvider

fun setPageItemProvider(provider: (S) -> List<Button>): PaginatedDynamicGUI<S>

Sets the button provider function for generating buttons based on the current state. This function is called to create a list of buttons whenever the state changes, allowing for dynamic button generation.

setPageItems

@ApiStatus.Internal

fun setPageItems(items: List<Button>): PaginatedDynamicGUI<S>

Sets the items to be paginated.

setPaginationEnabledStates

fun setPaginationEnabledStates(states: Set<S>): PaginatedDynamicGUI<S>

Specifies which states should use pagination.

setShouldCallGlobalListener

fun setShouldCallGlobalListener(shouldCallGlobalListener: Boolean): InventoryGUI

Sets whether the global listener should be called on inventory events.

setSize

fun setSize(size: Int): InventoryGUI

Sets the size of the inventory GUI.

setSlotPositions

fun setSlotPositions(slots: List<Int>): PaginatedDynamicGUI<S>

Sets the slot positions for the inventory GUI.

setState

fun setState(state: S): PaginatedDynamicGUI<S>

Updates the current state of the paginated dynamic GUI and resets the current page to the first one.

setStateFixedButtonProviders

fun setStateFixedButtonProviders(providers: Map<S, (S) -> List<Button>>): PaginatedDynamicGUI<S>

Sets the providers for fixed buttons associated with each state.

setTitle

fun setTitle(title: Component): InventoryGUI

Sets the title of the inventory GUI.

setTotalPages

fun setTotalPages(totalItems: Int): PaginatedDynamicGUI<S>

Sets the total number of pages. This method should be called after setting up items.

shouldCallGlobalListener

fun shouldCallGlobalListener(): Boolean

Indicates whether the global listener should be called on inventory events.

switchPage

fun switchPage(page: Int)

Switches the current page of the paginated GUI to the specified page index and updates its display.

switchState

fun switchState(state: S)

Switches the current state of the GUI to the specified state. If the given state is different from the current state, it updates the state, resets the current page to the first page (index 0), and updates the display.