ktInventory/dev.s7a.ktinventory/AbstractKtInventoryPaginatedSequence

AbstractKtInventoryPaginatedSequence

abstract class AbstractKtInventoryPaginatedSequence<T : AbstractKtInventoryPaginatedSequence<T>>(context: KtInventoryPluginContext, line: Int) : KtInventoryBase

Base class for sequence-backed paginated inventories.

Unlike AbstractKtInventoryPaginated, this class does not expose the last page number.

Since

2.2.0

Parameters

context

Plugin context

line

Number of inventory rows

Type Parameters

Type of the sequence-backed inventory

Inheritors

KtInventoryPaginatedSequence

KtInventoryPaginatedSequenceAdventure

Constructors

AbstractKtInventoryPaginatedSequence

constructor(context: KtInventoryPluginContext, line: Int)

Types

Entry

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

Represents a single page of sequence-backed inventory.

Refreshable

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

Base class for refreshable sequence-backed inventories.

Properties

buttons

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

Map of all buttons in the inventory

entries

abstract val entries: Sequence<KtInventoryButton<AbstractKtInventoryPaginatedSequence.Entry<T>>>

Sequence of entries to be paginated.

line

val line: Int

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

pagedStorables

val pagedStorables: Set<KtInventoryPagedStorable<AbstractKtInventoryPaginatedSequence.Entry<T>>>

Set of all paged storables in this inventory.

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(slots: Iterable<Int>, item: KtInventoryButton<KtInventoryBase>)

fun button(vararg slot: 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(slots: Iterable<Int>, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventory>) -> Unit = {})

fun button(vararg slot: 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<AbstractKtInventoryPaginatedSequence.Entry<T>>) -> Unit): KtInventoryButton<AbstractKtInventoryPaginatedSequence.Entry<T>>

Creates a new inventory button.

nextPageButton

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

fun nextPageButton(slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginatedSequence.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(slots: Iterable<Int>)

fun paginateSlot(vararg slots: Int)

Sets slots to be used for pagination.

previousPageButton

fun previousPageButton(slot: Int, item: KtInventoryButton<AbstractKtInventoryPaginatedSequence.Entry<T>>)

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

Adds a button to navigate to the previous page.

storable

fun storable(slots: Iterable<Int>, initialize: AbstractKtInventoryPaginatedSequence.Entry<T>.() -> List<ItemStack?> = { emptyList() }, onPreClick: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.ClickEvent) -> KtInventoryStorable.EventResult = { KtInventoryStorable.EventResult.Allow }, onClick: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.ClickEvent) -> Unit = {}, onPreDrag: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.DragEvent) -> KtInventoryStorable.EventResult = { KtInventoryStorable.EventResult.Allow }, onDrag: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.DragEvent) -> Unit = {}, save: AbstractKtInventoryPaginatedSequence.Entry<T>.(List<ItemStack?>) -> Unit = {}): KtInventoryPagedStorable<AbstractKtInventoryPaginatedSequence.Entry<T>>

fun storable(vararg slots: Int, initialize: AbstractKtInventoryPaginatedSequence.Entry<T>.() -> List<ItemStack?> = { emptyList() }, onPreClick: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.ClickEvent) -> KtInventoryStorable.EventResult = { KtInventoryStorable.EventResult.Allow }, onClick: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.ClickEvent) -> Unit = {}, onPreDrag: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.DragEvent) -> KtInventoryStorable.EventResult = { KtInventoryStorable.EventResult.Allow }, onDrag: AbstractKtInventoryPaginatedSequence.Entry<T>.(KtInventoryStorable.DragEvent) -> Unit = {}, save: AbstractKtInventoryPaginatedSequence.Entry<T>.(List<ItemStack?>) -> Unit = {})

Adds a storable that is applied to each created page entry.