Colosseum/me.spartacus04.colosseum.gui.items/SimpleItemProvider

SimpleItemProvider

class SimpleItemProvider(item: ItemStack) : AbstractItemProvider

A simple ItemProvider that always returns the same item and does nothing when clicked. This can be used for static items in the GUI that don't need to do anything when clicked, such as decorative items or placeholders.

Parameters

item

The item to display in the GUI. This item will be returned by the getItem() method and will not change unless the provider is replaced with a different one.

Constructors

SimpleItemProvider

constructor(item: ItemStack)

Functions

destroy

open fun destroy()

Cleans up any resources or references when this item provider is removed from the GUI. Subclasses can override this method to perform any necessary cleanup, such as canceling tasks or clearing references.

getItem

open override fun getItem(): ItemStack

Returns the ItemStack to be displayed for this item provider. This method must be implemented by subclasses to provide the actual item to display.

onClick

open override fun onClick(clickEvent: InventoryClickEvent)

Handles click events for this item provider. This method must be implemented by subclasses to define the behavior when the item is clicked in the GUI.

refresh

fun refresh()

Refreshes the item in the GUI. This method can be called by subclasses to update the displayed item after changes. It checks if the GUI reference is initialized and if the inventory slot is valid before attempting to refresh.

setGuiData

fun setGuiData(gui: Gui, slot: Int)

Sets the GUI reference and inventory slot for this item provider. This should be called by the GUI when adding this item provider to it.