KIA/de.staticred.kia.inventory/BaseKInventory

BaseKInventory

abstract class BaseKInventory(holder: KInventoryHolder, title: Component?, val size: Int) : AbstractContentContainer, KInventory

Example implementation of a generic inventory

Author

Devin

Since

1.0.0

Parameters

holder

holder of the inventory

Inheritors

BaseKInventoryImpl

Constructors

BaseKInventory

constructor(holder: KInventoryHolder, title: Component?, size: Int)

Properties

animations

open override val animations: MutableMap<String, Animation<KInventory>>

All animations Identifier maps to the animation

content

open override var content: MutableMap<Int, KItem>

Content of the container

currentAnimation

open override var currentAnimation: Animation<KInventory>?

The current animation if one is running

open override var id: UUID

The unique ID of this identifiable

inventories

open override var inventories: MutableList<Inventory>

Client side inventory instances

itemClickableWhileAnimating

open override var itemClickableWhileAnimating: Boolean

Sets whether the items can be clicked while the inventory is inside an animation

openingAnimation

open override var openingAnimation: Animation<KInventory>?

Animation which will be played when the inventory is opened

rowLength

val rowLength: Int

the length of a row in the inventory

size

val size: Int

of the content container, should be a multiple of the rowLength

title

open override var title: Component?

Title of the inventory rendered in the bukkit inventory

views

open override var views: MutableList<InventoryView>

Views which currently look at the inventory

Functions

addAnimation

open override fun addAnimation(identifier: String, animation: Animation<KInventory>)

Adds the animation

clearInventory

open override fun clearInventory()

Clears the inventory from all items inside it

closed

open override fun closed()

Sets the inventory to closed Should be called when the inventory has been closed.

getItems

open override fun getItems(): Map<Int, KItem>

Returns all the items in the inventory which have been set

getKHolder

open override fun getKHolder(): KInventoryHolder

Returns the KInventoryHolder of this inventory

getRowFor

open override fun getRowFor(index: Int): KRow

Gets the row for the given index This will create a new row for the returned value

getRowForItem

open override fun getRowForItem(item: KItem): KRow?

getSlotForItem

open override fun getSlotForItem(item: KItem): Int

hasID

open override fun hasID(): Boolean

isAnimating

open override fun isAnimating(): Boolean

Whether the object is currently inside an animation

isEqual

open override fun isEqual(inventory: Inventory): Boolean

Checks whether the given inventory is the same inventory

isOpened

open override fun isOpened(): Boolean

isPrivate

abstract override fun isPrivate(): Boolean

Checks whether the inventory is private. Private indicated that only one player at a time can open the same reference to a KInventory

itemClicked

open override fun itemClicked(item: ItemStack, player: Player, event: InventoryClickEvent)

Notifies the inventory that the given item has been clicked by the given player

onClose

open override fun onClose(action: KInventory.() -> Unit)

Executed when the inventory is closed To catch this the bukkit event is used

onItemClicked

open override fun onItemClicked(action: KInventory.(item: ItemStack, player: Player, event: InventoryClickEvent) -> Unit)

Executes the passed function, when a bukkit org.bukkit.inventory.ItemStack is clicked

onOpen

open override fun onOpen(action: KInventory.() -> Unit)

Executed when the inventory is opened To catch this the bukkit event is used

opened

open override fun opened()

Sets the inventory to opened Should be called when the inventory has been opened.

setItem

open override fun setItem(slot: Int, value: KItem)

Sets the given item at the given position

open override fun setItem(row: Int, slot: Int, item: KItem)

Sets the given item relative to the slot of the given row

setRow

abstract fun setRow(index: Int, row: KRow)

Sets the given row at the given index

startAnimation

open override fun startAnimation(animation: Animation<KInventory>)

Starts the given animation, but will not save it

open override fun startAnimation(identifier: String)

Starts the animation with the given identifier

swapRow

abstract fun swapRow(row: KRow, otherRow: KRow)

Swaps two rows in an inventory

abstract fun swapRow(index: Int, otherIndex: Int)

Swaps two rows based on their index

toBukkitInventory

open override fun toBukkitInventory(): Inventory

Constructs the bukkit inventory from this KInventory with the current set content