ktInventory/dev.s7a.ktinventory/AbstractKtInventoryPaginated

AbstractKtInventoryPaginated

abstract class AbstractKtInventoryPaginated<T : AbstractKtInventoryPaginated<T>>(plugin: Plugin, val line: Int) : KtInventoryBase

Base class for paginated inventories

Since

2.0.0

Parameters

Type of the paginated inventory

plugin

Plugin instance

line

Number of inventory rows

Inheritors

KtInventoryPaginated

KtInventoryPaginatedAdventure

Constructors

AbstractKtInventoryPaginated

constructor(plugin: Plugin, line: Int)

Types

Entry

abstract class Entry<T : AbstractKtInventoryPaginated<*>>(val paginated: T, val page: Int, val lastPage: Int) : AbstractKtInventory

Represents a single page of paginated inventory

Refreshable

abstract class Refreshable<T : AbstractKtInventoryPaginated<*>>(val clazz: KClass<T>) : RefreshableInventory<AbstractKtInventoryPaginated.Entry<T>>

Base 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<T>>>

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<T>>) -> Unit): KtInventoryButton<AbstractKtInventoryPaginated.Entry<T>>

Creates a new inventory button

nextPageButton

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

fun nextPageButton(slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginated.Entry<T>>) -> 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<T>>)

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

Adds a button to navigate to the previous page