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

Interface CustomItemData

All Known Subinterfaces:
NonVanillaCustomItemData
public interface CustomItemData
This is used to store data for a custom item.

  • Method Details

    • name

      @NonNull String name()
      Gets the item's name.
      Returns:
      the item's name

    • customItemOptions

      CustomItemOptions customItemOptions()
      Gets the custom item options of the item.
      Returns:
      the custom item options of the item.

    • displayName

      @NonNull String displayName()
      Gets the item's display name. By default, this is the item's name.
      Returns:
      the item's display name

    • icon

      @NonNull String icon()
      Gets the item's icon. By default, this is the item's name.
      Returns:
      the item's icon

    • allowOffhand

      boolean allowOffhand()
      Gets if the item is allowed to be put into the offhand.
      Returns:
      true if the item is allowed to be used in the offhand, false otherwise

    • displayHandheld

      boolean displayHandheld()
      Gets if the item should be displayed as handheld, like a tool.
      Returns:
      true if the item should be displayed as handheld, false otherwise

    • 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

    • textureSize

      int textureSize()
      Gets the item's texture size. This is to resize the item if the texture is not 16x16.
      Returns:
      the item's texture size

    • renderOffsets

      @Nullable CustomRenderOffsets renderOffsets()
      Gets the item's render offsets. If it is null, the item will be rendered normally, with no offsets.
      Returns:
      the item's render offsets

    • tags

      @NonNull Set<String> tags()
      Gets the item's set of tags that can be used in Molang. Equivalent to "tag:some_tag"
      Returns:
      the item's tags, if they exist

    • builder

      static CustomItemData.Builder builder()