KIA/de.staticred.kia.inventory.impl/KPageImpl

KPageImpl

class KPageImpl(var title: Component?, val rowLength: Int = 9, val size: Int = 3.rows) : AbstractContentContainer, KPage

Constructors

KPageImpl

constructor(title: Component?, rowLength: Int = 9, size: Int = 3.rows)

Properties

animations

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

All animations Identifier maps to the animation

content

abstract val content: MutableMap<Int, KItem>

Content of the container

currentAnimation

open override var currentAnimation: Animation<KPage>?

The current animation if one is running

footer

open override var footer: KPageController?

The footer will only be rendered, if the inventory is at least 2 rows long, and has no header, or is 3 rows long

header

open override var header: KPageController?

The header will only be rendered, if the inventory is at least 2 rows long, and has no footer, or is 3 rows long

openingAnimation

open override var openingAnimation: Animation<KPage>?

Animation played as soon as the page is opened

parent

open override var parent: KPageInventory?

Parent inventory if the page is set in it

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 page which will be rendered, can be configured using the TitleBuilder in the Parent Inventory

Functions

addAnimation

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

Adds the animation

clearInventory

abstract fun clearInventory()

Clears the inventory from all items inside it

closed

open override fun closed(inventory: KPageInventory)

Called by the parent inventory, when the page is closed

getRowFor

open override fun getRowFor(index: Int): KRow

Returns the given row for the index as a new object Parent of the row will only be set, if the page has a parent as well

hasFooter

open override fun hasFooter(): Boolean

hasHeader

open override fun hasHeader(): Boolean

isAnimating

open override fun isAnimating(): Boolean

Whether the object is currently inside an animation

onClosed

open override fun onClosed(action: KPage.(parent: KPageInventory) -> Unit)

Hook called when the page is closed, either when the page is clicked away, or the inventory is closed when the page is active

onOpened

open override fun onOpened(action: KPage.(parent: KPageInventory) -> Unit)

Hook called when the page is opened, either when the page is clicked to, or it's the first page of the parent inventory

opened

open override fun opened(inventory: KPageInventory)

Called by the parent inventory, when the page is 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

open override fun setRow(index: Int, row: KRow)

Sets the given row at the given index

startAnimation

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

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