Kt
abstract class KtInventoryPaginatedSequence(context: KtInventoryPluginContext, line: Int, altColorChar: Char? = '&') : AbstractKtInventoryPaginatedSequence<KtInventoryPaginatedSequence>
Abstract class for sequence-backed inventories with customizable titles.
Since
2.2.0
Parameters
context
Plugin context
line
Number of inventory lines (1-6)
alt
The alternate color code character for title color formatting, defaults to '&'
Types
Link copied to clipboard
class Entry<T : KtInventoryPaginatedSequence>(paginated: T, page: Int) : AbstractKtInventoryPaginatedSequence.Entry<T>
Represents a single page entry in the sequence-backed inventory.
Link copied to clipboard
abstract class Refreshable<T : KtInventoryPaginatedSequence>(clazz: KClass<T>) : AbstractKtInventoryPaginatedSequence.Refreshable<T>
Abstract class for refreshable sequence-backed inventories.
Properties
Link copied to clipboard
Map of all buttons in the inventory
Link copied to clipboard
abstract val entries: Sequence<KtInventoryButton<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>>
Sequence of entries to be paginated.
Link copied to clipboard
val pagedStorables: Set<KtInventoryPagedStorable<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>>
Set of all paged storables in this inventory.
Functions
Link copied to clipboard
Adds an existing button to a single slot
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
Link copied to clipboard
fun createButton(itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>) -> Unit): KtInventoryButton<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>
Creates a new inventory button.
Link copied to clipboard
fun nextPageButton(slot: Int, item: KtInventoryButton<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>)
fun nextPageButton(slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>) -> Unit = {})
Adds a button to navigate to the next page.
Link copied to clipboard
Called when bottom inventory is clicked
Link copied to clipboard
Sets slots to be used for pagination.
Link copied to clipboard
fun previousPageButton(slot: Int, item: KtInventoryButton<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>)
fun previousPageButton(slot: Int, itemStack: ItemStack, onClick: (KtInventoryButton.ClickEvent<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>) -> Unit = {})
Adds a button to navigate to the previous page.
Link copied to clipboard
fun storable(slots: Iterable<Int>, initialize: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.() -> List<ItemStack?> = { emptyList() }, onPreClick: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.ClickEvent) -> KtInventoryStorable.EventResult = {
KtInventoryStorable.EventResult.Allow
}, onClick: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.ClickEvent) -> Unit = {}, onPreDrag: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.DragEvent) -> KtInventoryStorable.EventResult = {
KtInventoryStorable.EventResult.Allow
}, onDrag: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.DragEvent) -> Unit = {}, save: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(List<ItemStack?>) -> Unit = {}): KtInventoryPagedStorable<AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>>
fun storable(vararg slots: Int, initialize: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.() -> List<ItemStack?> = { emptyList() }, onPreClick: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.ClickEvent) -> KtInventoryStorable.EventResult = {
KtInventoryStorable.EventResult.Allow
}, onClick: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.ClickEvent) -> Unit = {}, onPreDrag: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.DragEvent) -> KtInventoryStorable.EventResult = {
KtInventoryStorable.EventResult.Allow
}, onDrag: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(KtInventoryStorable.DragEvent) -> Unit = {}, save: AbstractKtInventoryPaginatedSequence.Entry<KtInventoryPaginatedSequence>.(List<ItemStack?>) -> Unit = {})
Adds a storable that is applied to each created page entry.