ktInventory/dev.s7a.ktinventory/AbstractKtInventoryPaginatedFetched/Entry

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.

Since

2.2.0

Parameters

paginated

Parent inventory

condition

Current display condition

page

Fetched page data

Type Parameters

Type of the fetched inventory

Type of the display condition

Inheritors

Entry

Constructors

Entry

constructor(paginated: T, condition: C, page: AbstractKtInventoryPaginatedFetched.Page<C, KtInventoryButton<AbstractKtInventoryPaginatedFetched.Entry<T, C>>>)

Properties

buttons

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

Map of all buttons in the inventory

condition

val condition: C

inventory

@get:NotNull

abstract val inventory: @NotNull Inventory

line

val line: Int

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

page

val page: AbstractKtInventoryPaginatedFetched.Page<C, KtInventoryButton<AbstractKtInventoryPaginatedFetched.Entry<T, C>>>

paginated

val paginated: T

size

val size: Int

Total size of inventory (line * 9)

storableOption

open val storableOption: KtInventoryStorableOption

Storage options for this inventory's storable components

storables

val storables: Set<KtInventoryStorable>

Set of all storable components in this inventory

viewers

val viewers: List<HumanEntity>

List of entities currently viewing this inventory

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<AbstractKtInventory>) -> Unit): KtInventoryButton<AbstractKtInventory>

Creates a new inventory button with the specified item and click handler

getItem

fun getItem(slot: Int): @Nullable ItemStack?

Gets the item at the specified slot

getStorables

fun getStorables(slot: Int): List<KtInventoryStorable>

Gets all storables that have the given slot

fun getStorables(slots: Iterable<Int>): List<KtInventoryStorable>

Gets all storables that have any of the given slots

onClick

open override fun onClick(event: InventoryClickEvent)

Called when top inventory is clicked

onClickBottom

open fun onClickBottom(event: InventoryClickEvent)

Called when bottom inventory is clicked

onClose

open override fun onClose(event: InventoryCloseEvent)

Called when inventory is closed

onDrag

open fun onDrag(event: InventoryDragEvent)

Called when items are dragged in inventory

onOpen

open override fun onOpen(event: InventoryOpenEvent)

Called when inventory is opened

open

override fun open(player: HumanEntity)

Opens this inventory for the given player

openNextPage

fun openNextPage(player: HumanEntity)

Opens the next page for a player if Page.nextCondition is available.

openPreviousPage

fun openPreviousPage(player: HumanEntity)

Opens the previous page for a player if Page.previousCondition is available.

saveStorables

fun saveStorables()

Saves the state of all storable components in this inventory

setItem

fun setItem(slot: Int, item: ItemStack?)

Sets an item at the specified slot

storable

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

Add a storable component using all slots in the inventory

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

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

Add a storable component with the specified slot numbers