vital-inventories/dev.vitalframework.inventories/VitalInventory

VitalInventory

open class VitalInventory : VitalHasInfo

Defines an inventory menu within the Vital-Framework. An inventory menu is a GUI used to display information to a player, and process a player's inputs.

By default, the class will be a bean.

@VitalInventory.Info(
  name = "MyInventory",
  type = VitalInventory.Type.GENERIC_9X1,
  background = Material.COBBLESTONE
)
public class MyInventory extends VitalInventory {
  @Override
  public void onUpdate() {
    // This function is called when someone or something triggers an inventory update.
    // It should not be used to set player-specific items, only global ones.
  }

  @Override
  public void onUpdate(Player player) {
    // This function is called when someone or something triggers an inventory update with a player.
    // It should be used to set player-specific items, not global ones.
  }

  // ...
}

Inheritors

VitalPagedInventory

Constructors

VitalInventory

constructor()

Types

Info

@Component

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Info(val type: VitalInventory.Type, val name: String, val background: Material = Material.AIR)

Defines the info for a VitalInventory.

Type

enum Type : Enum<VitalInventory.Type>

Defines the supported MenuTypes a VitalInventory can use.

Properties

actions

val actions: MutableMap<UUID, MutableMap<Int, Consumer<InventoryClickEvent>>>

background

val background: ItemStack

info

open override val info: MutableMap<Class<out Annotation>, Annotation>

items

val items: MutableMap<UUID, MutableMap<Int, ItemStack?>>

playerInventories

val playerInventories: MutableMap<UUID, InventoryView>

previousInventories

val previousInventories: MutableMap<UUID, VitalInventory>

Functions

click

open fun click(e: InventoryClickEvent)

Internal function to handle a InventoryClickEvent for this inventory. If the clicked item has an action attached to it via setItem, the action will be triggered.

open fun close(player: SpigotPlayer)

Closes this inventory for the given player. This function will clean up the state for this inventory and eventually call the onClose lifecycle function for the given player.

getActions

fun getActions(playerUniqueId: UUID): MutableMap<Int, Consumer<InventoryClickEvent>>

Gets all mapped actions for the given playerUniqueId. This function will never return null, even if the given playerUniqueId doesn't have this inventory open.

getInfo

open fun <T : Annotation> getInfo(type: Class<T>): T

getInventory

fun getInventory(playerUniqueId: UUID): InventoryView?

Gets the actual InventoryView for the given playerUniqueId. This function will return null if the given playerUniqueId doesn't have this inventory open.

getItems

fun getItems(playerUniqueId: UUID): MutableMap<Int, ItemStack?>

Gets all items for the given playerUniqueId. This function will never return null, even if the given playerUniqueId doesn't have this inventory open.

hasInventoryOpen

fun hasInventoryOpen(player: SpigotPlayer): Boolean

Checks if the given SpigotPlayer currently has this inventory open.

open

@JvmOverloads

open fun open(player: SpigotPlayer, previousInventory: VitalInventory? = null)

Opens this inventory for the given player and updates it via update. If a previousInventory was given, clicking outside of this inventory view will open the previous inventory.

setItem

@JvmOverloads

fun setItem(player: SpigotPlayer, slot: Int, item: ItemStack?, action: Consumer<InventoryClickEvent> = Consumer {})

Sets the given item in the slot for the inventory of the given player. Once the player opens this inventory, the actual InventoryView will be populated with all items set via this function. Additionally, an item may have an action attached to it.

update

fun update()

Updates this inventory for all players currently viewing it. Calling this function will call the onUpdate lifecycle function.

open fun update(player: SpigotPlayer)

Updates this inventory for the given player. All previously set items via setItem will be populated in the inventory for the given player. If the player doesn't have this inventory open, this function does nothing.