Package net.okocraft.box.api.model.item

Interface BoxItem

All Known Subinterfaces:
BoxCustomItem, BoxDefaultItem
public interface BoxItem
An interface of the item that can deposit or withdraw.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull org.bukkit.inventory.ItemStack
    getClonedItem()
    Gets the cloned ItemStack.
    @NotNull Component
    getDisplayName()
    Gets the display name of this item as a Component.
    int
    getInternalId()
    Gets the internal id of this item.
    @NotNull org.bukkit.inventory.ItemStack
    getOriginal()
    Gets the original ItemStack.
    @NotNull String
    getPlainName()
    Gets the plain name of this item.

  • Method Details

    • getInternalId

      int getInternalId()
      Gets the internal id of this item.
      Returns:
      the internal id of this id

    • getPlainName

      @NotNull @NotNull String getPlainName()
      Gets the plain name of this item.
      Returns:
      the plain name of this item

    • getOriginal

      @NotNull @NotNull org.bukkit.inventory.ItemStack getOriginal()
      Gets the original ItemStack.

      The item returned by this method must not be modified.

      If you want to change it, you should use getClonedItem().

      Returns:
      the original ItemStack

    • getClonedItem

      @NotNull @NotNull org.bukkit.inventory.ItemStack getClonedItem()
      Gets the cloned ItemStack.
      Returns:
      the cloned ItemStack

    • getDisplayName

      @NotNull @NotNull Component getDisplayName()
      Gets the display name of this item as a Component.
      Returns:
      the display name of this item as a Component