igf

1.5.6

igf/net.ririfa.igf/SimpleGUI

SimpleGUI

class SimpleGUI(player: Player) : InventoryGUI

A simple GUI class that provides basic inventory GUI functionality. It allows setting up buttons, listeners, and background materials for GUI customization. This class can be extended to create more complex GUIs.

Since

1.0.0

Author

RiriFa

Parameters

player

The player who will view the GUI.

See also

Constructors

constructor(player: Player)

Properties

var items: List<Button>

Represents the list of buttons to be displayed in this inventory GUI. Each button corresponds to a slot and can define its own material, name, custom data, and click behavior.

var onCloseFunc: (SimpleGUI) -> Unit

Functions

fun addItem(button: Button): InventoryGUI

Adds a single item to the existing item list.

open override fun build(): InventoryGUI

Abstract method for building the inventory GUI. This method should be implemented by subclasses to define the layout and items of the GUI.

fun close()

Closes the inventory for the player.

open override fun getAllButtons(): List<Button>

getBackgroundMaterial

fun getBackgroundMaterial(): Material?

Gets the background material set for the inventory GUI.

open override fun getInventory(): Inventory

Returns the inventory associated with this GUI.

fun getListener(): GUIListener?

Gets the current listener associated with this GUI.

fun getSize(): Int?

Gets the size of the inventory GUI.

fun getTitle(): Component?

Gets the title of this GUI.

fun onClose(block: (SimpleGUI) -> Unit): SimpleGUI

fun open()

Opens the inventory for the player.

fun setBackground(background: Material): InventoryGUI

Sets the background material for the inventory GUI.

fun setItems(items: List<Button>): InventoryGUI

Sets multiple items at once for the GUI. This replaces the existing item list.

fun ~~setListener~~(listener: GUIListener): InventoryGUI

Sets the listener for handling GUI events.

setShouldCallGlobalListener

fun setShouldCallGlobalListener(shouldCallGlobalListener: Boolean): InventoryGUI

Sets whether the global listener should be called on inventory events.

fun setSize(size: Int): InventoryGUI

Sets the size of the inventory GUI.

fun setTitle(title: Component): InventoryGUI

Sets the title of the inventory GUI.

shouldCallGlobalListener

fun shouldCallGlobalListener(): Boolean

Indicates whether the global listener should be called on inventory events.