Package org.geysermc.geyser.api.item.custom

Interface NonVanillaCustomItemData

All Superinterfaces:
CustomItemData
public interface NonVanillaCustomItemData extends CustomItemData
Represents a completely custom item that is not based on an existing vanilla Minecraft item.

  • Method Details

    • identifier

      @NonNull String identifier()
      Gets the java identifier for this item.
      Returns:
      The java identifier for this item.

    • javaId

      @org.checkerframework.checker.index.qual.NonNegative int javaId()
      Gets the java item id of the item.
      Returns:
      the java item id of the item

    • stackSize

      @org.checkerframework.checker.index.qual.NonNegative int stackSize()
      Gets the stack size of the item.
      Returns:
      the stack size of the item

    • maxDamage

      int maxDamage()
      Gets the max damage of the item.
      Returns:
      the max damage of the item

    • toolType

      @Nullable String toolType()
      Gets the tool type of the item.
      Returns:
      the tool type of the item

    • toolTier

      @Nullable String toolTier()
      Gets the tool tier of the item.
      Returns:
      the tool tier of the item

    • armorType

      @Nullable String armorType()
      Gets the armor type of the item.
      Returns:
      the armor type of the item

    • protectionValue

      int protectionValue()
      Gets the armor protection value of the item.
      Returns:
      the armor protection value of the item

    • translationString

      @Nullable String translationString()
      Gets the item's translation string.
      Returns:
      the item's translation string

    • repairMaterials

      @Nullable Set<String> repairMaterials()
      Gets the repair materials of the item.
      Returns:
      the repair materials of the item

    • creativeCategory

      @NonNull OptionalInt creativeCategory()
      Gets the item's creative category, or tab id.
      Returns:
      the item's creative category

    • creativeGroup

      @Nullable String creativeGroup()
      Gets the item's creative group.
      Returns:
      the item's creative group

    • isHat

      boolean isHat()
      Gets if the item is a hat. This is used to determine if the item should be rendered on the player's head, and normally allow the player to equip it. This is not meant for armor.
      Returns:
      if the item is a hat

    • isTool

      @Deprecated default boolean isTool()
      Deprecated.
      Use CustomItemData.displayHandheld() instead. Gets if the item is a tool. This is used to set the render type of the item, if the item is handheld.
      Returns:
      if the item is a tool

    • builder

      static NonVanillaCustomItemData.Builder builder()