ktInventory/dev.s7a.ktinventory/KtInventoryBase

KtInventoryBase

abstract class KtInventoryBase(val line: Int)

Base class for creating custom inventories.

Since

2.0.0

Inheritors

AbstractKtInventory

AbstractKtInventoryPaginated

Constructors

KtInventoryBase

constructor(line: Int)

Properties

buttons

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

Map of all buttons in the inventory

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

open 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

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

abstract fun open(player: HumanEntity)

Opens this inventory for the given player