Package io.papermc.paper.registry.data.dialog.body

Interface ItemDialogBody

All Superinterfaces:
DialogBody
@NonExtendable public non-sealed interface ItemDialogBody extends DialogBody
An item body for a dialog.

Created via DialogBody.item(ItemStack, PlainMessageDialogBody, boolean, boolean, int, int)

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ItemDialogBody.Builder
    A builder for an item dialog body.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable PlainMessageDialogBody
    description()
    The description of the body, or null if not set.
    @org.jetbrains.annotations.Range(from=1L, to=256L) int
    height()
    The height of the item body.
    ItemStack
    item()
    The item to display in the dialog.
    boolean
    showDecorations()
    Whether to show decorations around the item.
    boolean
    showTooltip()
    Whether to show a tooltip for the item.
    @org.jetbrains.annotations.Range(from=1L, to=256L) int
    width()
    The width of the item body.

  • Method Details

    • item

      @Contract(pure=true) ItemStack item()
      The item to display in the dialog.
      Returns:
      the item stack

    • description

      @Contract(pure=true) @Nullable PlainMessageDialogBody description()
      The description of the body, or null if not set.
      Returns:
      the description body

    • showDecorations

      @Contract(pure=true) boolean showDecorations()
      Whether to show decorations around the item.

      Decorations include damage, itemstack count, etc.

      Returns:
      true if decorations should be shown

    • showTooltip

      @Contract(pure=true) boolean showTooltip()
      Whether to show a tooltip for the item.
      Returns:
      true if a tooltip should be shown

    • width

      @Contract(pure=true) @org.jetbrains.annotations.Range(from=1L, to=256L) int width()
      The width of the item body.
      Returns:
      the width

    • height

      @Contract(pure=true) @org.jetbrains.annotations.Range(from=1L, to=256L) int height()
      The height of the item body.
      Returns:
      the height