ktInventory/dev.s7a.ktinventory/AbstractKtInventoryPaginatedFetched

AbstractKtInventoryPaginatedFetched

abstract class AbstractKtInventoryPaginatedFetched<T : AbstractKtInventoryPaginatedFetched<T, C>, C : Any>(context: KtInventoryPluginContext, line: Int) : KtInventoryBase

Base class for inventories that fetch entries by display condition.

Since

2.2.0

Parameters

context

Plugin context

line

Number of inventory rows

Type Parameters

Type of the fetched inventory

Type of the display condition

Inheritors

KtInventoryPaginatedFetched

KtInventoryPaginatedFetchedAdventure

Constructors

AbstractKtInventoryPaginatedFetched

constructor(context: KtInventoryPluginContext, line: Int)

Types

Entry

abstract class Entry<T : AbstractKtInventoryPaginatedFetched<T, C>, C : Any>(val paginated: T, val condition: C, val page: AbstractKtInventoryPaginatedFetched.Page<C, KtInventoryButton<AbstractKtInventoryPaginatedFetched.Entry<T, C>>>) : AbstractKtInventory

Represents a single fetched inventory page.

Page

data class Page<C : Any, E>(val entries: List<E>, val previousCondition: C? = null, val nextCondition: C? = null)

Fetched page data.

Refreshable

abstract class Refreshable<T : AbstractKtInventoryPaginatedFetched<*, C>, C : Any>(val clazz: KClass<T>) : RefreshableInventory<AbstractKtInventoryPaginatedFetched.Entry<*, C>>

Base class for refreshable condition-fetched paginated inventories.

Properties

buttons

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

Map of all buttons in the inventory

initialCondition

abstract val initialCondition: C

Initial display condition used by open.

line

val line: Int

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

pagedStorables

val pagedStorables: Set<KtInventoryPagedStorable<AbstractKtInventoryPaginatedFetched.Entry<T, C>>>

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<AbstractKtInventoryPaginatedFetched.Entry<T, C>>) -> Unit): KtInventoryButton<AbstractKtInventoryPaginatedFetched.Entry<T, C>>

Creates a new inventory button.

nextPageButton

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

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

Adds a button to navigate to the next condition.

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, condition: C)

Opens the inventory for a player using the specified display condition.

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<AbstractKtInventoryPaginatedFetched.Entry<T, C>>)

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

Adds a button to navigate to the previous condition.

storable

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

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