ktInventory/dev.s7a.ktinventory/KtInventoryPaginated

KtInventoryPaginated

abstract class KtInventoryPaginated(plugin: Plugin, line: Int, altColorChar: Char? = '&') : AbstractKtInventoryPaginated<KtInventoryPaginated>

Abstract class for paginated inventories with customizable titles.

Since

2.0.0

Parameters

plugin

The plugin instance

line

Number of inventory lines (1-6)

altColorChar

The alternate color code character for title color formatting, defaults to '&'

Constructors

KtInventoryPaginated

constructor(plugin: Plugin, line: Int, altColorChar: Char? = '&')

Types

Entry

class Entry<T : KtInventoryPaginated>(paginated: T, page: Int, lastPage: Int) : AbstractKtInventoryPaginated.Entry<T>

Represents a single page entry in the paginated inventory.

Refreshable

abstract class Refreshable<T : KtInventoryPaginated>(clazz: KClass<T>) : AbstractKtInventoryPaginated.Refreshable<T>

Abstract class for refreshable paginated inventories.

Properties

buttons

val buttons: Map<Int, KtInventoryButton<KtInventoryBase>>

Map of all buttons in the inventory

entries

abstract val entries: List<KtInventoryButton<AbstractKtInventoryPaginated.Entry<KtInventoryPaginated>>>

List of entries to be paginated

line

val line: Int

Number of rows in the inventory (must be between 1 and 6)

size

val size: Int

Total size of inventory (line * 9)

Functions

button

override fun button(slot: Int, item: KtInventoryButton<KtInventoryBase>)

Adds an existing button to a single slot

fun button(vararg slot: Int, item: KtInventoryButton<KtInventoryBase>)

fun button(slots: Iterable<Int>, item: KtInventoryButton<KtInventoryBase>)

Adds an existing button to multiple slots

fun button(slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventory>) -> Unit = {})

Adds a button to a single slot with the given item and click handler

fun button(vararg slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventory>) -> Unit = {})

fun button(slots: Iterable<Int>, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventory>) -> Unit = {})

Adds a button to multiple slots with the given item and click handler

createButton

fun createButton(itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginated.Entry<KtInventoryPaginated>>) -> Unit): KtInventoryButton<AbstractKtInventoryPaginated.Entry<KtInventoryPaginated>>

Creates a new inventory button

nextPageButton

fun nextPageButton(slot: Int, item: KtInventoryButton<AbstractKtInventoryPaginated.Entry<KtInventoryPaginated>>)

fun nextPageButton(slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginated.Entry<KtInventoryPaginated>>) -> Unit = {})

Adds a button to navigate to the next page

onClick

open fun onClick(event: InventoryClickEvent)

Called when top inventory is clicked

onClickBottom

open fun onClickBottom(event: InventoryClickEvent)

Called when bottom inventory is clicked

onClose

open fun onClose(event: InventoryCloseEvent)

Called when inventory is closed

onDrag

open fun onDrag(event: InventoryDragEvent)

Called when items are dragged in inventory

onOpen

open fun onOpen(event: InventoryOpenEvent)

Called when inventory is opened

open

override fun open(player: HumanEntity)

Opens this inventory for the given player

fun open(player: HumanEntity, page: Int)

Opens specific page of the inventory for a player

paginateSlot

fun paginateSlot(vararg slots: Int)

fun paginateSlot(slots: Iterable<Int>)

Sets slots to be used for pagination

previousPageButton

fun previousPageButton(slot: Int, item: KtInventoryButton<AbstractKtInventoryPaginated.Entry<KtInventoryPaginated>>)

fun previousPageButton(slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginated.Entry<KtInventoryPaginated>>) -> Unit = {})

Adds a button to navigate to the previous page

title

abstract fun title(page: Int, lastPage: Int): String

Generates the title for a specific page of the inventory.