igf

1.5.6

igf/net.ririfa.igf/PaginatedGUI

PaginatedGUI

class PaginatedGUI(player: Player) : InventoryGUI

A class that provides paginated inventory GUI functionality with improved item management. It allows dynamic page navigation, slot management, and customization using PersistentDataContainer.

Since

1.0.0

Author

RiriFa

Parameters

player

The player who will view the GUI.

See also

Constructors

constructor(player: Player)

Properties

var currentPage: Int

emptyMessageButton

var emptyMessageButton: Button?

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.

var itemsPerPage: Int

var nextPageButton: Button?

var onCloseFunc: (PaginatedGUI) -> Unit?

var pageItems: List<Button>

var prevPageButton: Button?

var slotPositions: List<Int>

var totalPages: Int

Functions

fun addItem(button: Button): InventoryGUI

Adds a single item to the existing item list.

open override fun build(): PaginatedGUI

Abstract method for building the inventory GUI. This method should be implemented by subclasses to define the layout and items of the GUI.

fun close()

Closes the inventory for the player.

displayItemsForPage

fun displayItemsForPage()

Updates the inventory to display items for the current page.

open override fun getAllButtons(): List<Button>

getBackgroundMaterial

fun getBackgroundMaterial(): Material?

Gets the background material set for the inventory GUI.

open override fun getInventory(): Inventory

Returns the inventory associated with this GUI.

fun getListener(): GUIListener?

Gets the current listener associated with this GUI.

fun getSize(): Int?

Gets the size of the inventory GUI.

fun getTitle(): Component?

Gets the title of this GUI.

fun nextPage(): PaginatedGUI

fun onClose(block: (PaginatedGUI) -> Unit): PaginatedGUI

fun open()

Opens the inventory for the player.

fun prevPage(): PaginatedGUI

fun setBackground(background: Material): InventoryGUI

Sets the background material for the inventory GUI.

setCountOfItemsPerPage

fun setCountOfItemsPerPage(itemsPerPage: Int): PaginatedGUI

Sets the number of items per page.

setEmptyMessageButton

fun setEmptyMessageButton(button: Button): PaginatedGUI

Sets a default button to display when there are no items.

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

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

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

Sets the listener for handling GUI events.

fun setPage(page: Int): PaginatedGUI

Sets the current page for the inventory.

setPageChangeButtons

fun setPageChangeButtons(prevButton: Button, nextButton: Button): PaginatedGUI

Sets the buttons for page navigation.

fun setPageItems(items: List<Button>): PaginatedGUI

Sets the items to be paginated.

setShouldCallGlobalListener

fun setShouldCallGlobalListener(shouldCallGlobalListener: Boolean): InventoryGUI

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

fun setSize(size: Int): InventoryGUI

Sets the size of the inventory GUI.

setSlotPositions

fun setSlotPositions(slots: List<Int>): PaginatedGUI

Sets the slot positions for items.

fun setTitle(title: Component): InventoryGUI

Sets the title of the inventory GUI.

fun setTotalPages(totalItems: Int): PaginatedGUI

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.