Package io.papermc.paper.datacomponent.item

Interface ItemLore

@NullMarked @Experimental @NonExtendable public interface ItemLore
Additional lines to include in an item's tooltip.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    ItemLore.Builder
    Builder for ItemLore.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Unmodifiable List<net.kyori.adventure.text.Component>
    lines()
    Lists the components that are added to an item's tooltip.
    static ItemLore.Builder
    lore()
     
    static ItemLore
    lore(List<? extends net.kyori.adventure.text.ComponentLike> lines)
     
    @Unmodifiable List<net.kyori.adventure.text.Component>
    styledLines()
    Lists the styled components (example: italicized and purple) that are added to an item's tooltip.

  • Method Details

    • lore

      @Contract(value="_ -> new", pure=true) static ItemLore lore(List<? extends net.kyori.adventure.text.ComponentLike> lines)

    • lore

      @Contract(value="-> new", pure=true) static ItemLore.Builder lore()

    • lines

      @Contract(pure=true) @Unmodifiable List<net.kyori.adventure.text.Component> lines()
      Lists the components that are added to an item's tooltip.
      Returns:
      component list

    • styledLines

      @Contract(pure=true) @Unmodifiable List<net.kyori.adventure.text.Component> styledLines()
      Lists the styled components (example: italicized and purple) that are added to an item's tooltip.
      Returns:
      component list