Package com.cryptomorin.xseries

Enum Class XItemFlag

java.lang.Object
java.lang.Enum<XItemFlag>
com.cryptomorin.xseries.XItemFlag
All Implemented Interfaces:
XBase<XItemFlag,org.bukkit.inventory.ItemFlag>, Serializable, Comparable<XItemFlag>, Constable
public enum XItemFlag extends Enum<XItemFlag> implements XBase<XItemFlag,org.bukkit.inventory.ItemFlag>
An ItemFlag can hide some attributes from ItemStack. These are also known as HideFlags in Vanilla Minecraft.

You might find decorationOnly(ItemMeta) useful if you're using this for GUIs.

  • Enum Constant Details

    • HIDE_ADDITIONAL_TOOLTIP

      @XInfo(since="1.20.4") @XChange(version="1.21", from="HIDE_POTION_EFFECTS", to="HIDE_ADDITIONAL_TOOLTIP") public static final XItemFlag HIDE_ADDITIONAL_TOOLTIP
      Setting to show/hide potion effects, book and firework information, map tooltips, patterns of banners.
      See Also:

    • HIDE_ARMOR_TRIM

      public static final XItemFlag HIDE_ARMOR_TRIM
      Armor trim names.
      See Also:
      • ArmorTrim

    • HIDE_ATTRIBUTES

      public static final XItemFlag HIDE_ATTRIBUTES
      See Also:

    • HIDE_DESTROYS

      public static final XItemFlag HIDE_DESTROYS
      Show or hide what block this item can break.

      This tag is used when making adventure maps to allow a specific tool/item to break a block. Apply the tag to any item/tool. If the value is not a valid block or item it displays as "missingno".

      Controlled by "CanDestroy" NBTTagList of NBTTagString of the block's namespaced material name. {CanDestroy:["minecraft:stone","#minecraft:logs","minecraft:player_head[rotation=8]{SkullOwner:{Name:'Dinnerbone'}}"]}

      Paper also provides its own API method for this from ItemMeta.setCanDestroy(Set<Material> canDestroy).

    • HIDE_DYE

      public static final XItemFlag HIDE_DYE
      Dye names for colored leather armors.
      See Also:
      • LeatherArmorMeta

    • HIDE_ENCHANTS

      public static final XItemFlag HIDE_ENCHANTS
      See Also:

    • HIDE_PLACED_ON

      public static final XItemFlag HIDE_PLACED_ON
      List of blocks that this item (must be a placeable block) can be placed on.

      This tag is used when making adventure maps to determine which block(s) the player can place a block on. Also used on hoes to make them till dirt and on spawn eggs to place them. If the value is not a valid block or item it displays as "missingno".

      Controlled by "CanPlaceOn" NBTTagList of NBTTagString of the block's namespaced material name. {CanPlaceOn:["minecraft:stone","#minecraft:logs","minecraft:player_head[rotation=8]{SkullOwner:{Name:'Dinnerbone'}}"]}

      Paper also provides its own API method for this from ItemMeta.setCanPlaceOn(Set<Material> canDestroy).

    • HIDE_STORED_ENCHANTMENTS

      @XInfo(since="1.21.3") @XChange(version="1.21.5", from="HIDE_STORED_ENCHANTS", to="HIDE_STORED_ENCHANTMENTS") public static final XItemFlag HIDE_STORED_ENCHANTMENTS
      Setting to show/hide stored enchants on an item, such as enchantments on an enchanted book. This functionality was split from HIDE_ADDITIONAL_TOOLTIP in v1.21.3

      Related links:

      See Also:

    • HIDE_UNBREAKABLE

      public static final XItemFlag HIDE_UNBREAKABLE
      This is not the same as XEnchantment.UNBREAKING enchant. For the blue "Unbreakable" text below attributes.
      See Also:
      • ItemMeta.setUnbreakable(boolean)

    • HIDE_CUSTOM_DATA

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CUSTOM_DATA

    • HIDE_MAX_STACK_SIZE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_MAX_STACK_SIZE

    • HIDE_MAX_DAMAGE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_MAX_DAMAGE

    • HIDE_DAMAGE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_DAMAGE

    • HIDE_CUSTOM_NAME

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CUSTOM_NAME

    • HIDE_ITEM_NAME

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_ITEM_NAME

    • HIDE_ITEM_MODEL

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_ITEM_MODEL

    • HIDE_LORE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_LORE

    • HIDE_RARITY

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_RARITY

    • HIDE_ENCHANTMENTS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_ENCHANTMENTS

    • HIDE_CAN_PLACE_ON

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CAN_PLACE_ON

    • HIDE_CAN_BREAK

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CAN_BREAK

    • HIDE_ATTRIBUTE_MODIFIERS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_ATTRIBUTE_MODIFIERS

    • HIDE_CUSTOM_MODEL_DATA

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CUSTOM_MODEL_DATA

    • HIDE_TOOLTIP_DISPLAY

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_TOOLTIP_DISPLAY

    • HIDE_REPAIR_COST

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_REPAIR_COST

    • HIDE_CREATIVE_SLOT_LOCK

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CREATIVE_SLOT_LOCK

    • HIDE_ENCHANTMENT_GLINT_OVERRIDE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_ENCHANTMENT_GLINT_OVERRIDE

    • HIDE_INTANGIBLE_PROJECTILE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_INTANGIBLE_PROJECTILE

    • HIDE_FOOD

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_FOOD

    • HIDE_CONSUMABLE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CONSUMABLE

    • HIDE_USE_REMAINDER

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_USE_REMAINDER

    • HIDE_USE_COOLDOWN

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_USE_COOLDOWN

    • HIDE_DAMAGE_RESISTANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_DAMAGE_RESISTANT

    • HIDE_TOOL

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_TOOL

    • HIDE_WEAPON

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_WEAPON

    • HIDE_ENCHANTABLE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_ENCHANTABLE

    • HIDE_EQUIPPABLE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_EQUIPPABLE

    • HIDE_REPAIRABLE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_REPAIRABLE

    • HIDE_GLIDER

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_GLIDER

    • HIDE_TOOLTIP_STYLE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_TOOLTIP_STYLE

    • HIDE_DEATH_PROTECTION

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_DEATH_PROTECTION

    • HIDE_BLOCKS_ATTACKS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BLOCKS_ATTACKS

    • HIDE_DYED_COLOR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_DYED_COLOR

    • HIDE_MAP_COLOR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_MAP_COLOR

    • HIDE_MAP_ID

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_MAP_ID

    • HIDE_MAP_DECORATIONS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_MAP_DECORATIONS

    • HIDE_MAP_POST_PROCESSING

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_MAP_POST_PROCESSING

    • HIDE_CHARGED_PROJECTILES

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CHARGED_PROJECTILES

    • HIDE_BUNDLE_CONTENTS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BUNDLE_CONTENTS

    • HIDE_POTION_CONTENTS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_POTION_CONTENTS

    • HIDE_POTION_DURATION_SCALE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_POTION_DURATION_SCALE

    • HIDE_SUSPICIOUS_STEW_EFFECTS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_SUSPICIOUS_STEW_EFFECTS

    • HIDE_WRITABLE_BOOK_CONTENT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_WRITABLE_BOOK_CONTENT

    • HIDE_WRITTEN_BOOK_CONTENT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_WRITTEN_BOOK_CONTENT

    • HIDE_TRIM

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_TRIM

    • HIDE_DEBUG_STICK_STATE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_DEBUG_STICK_STATE

    • HIDE_ENTITY_DATA

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_ENTITY_DATA

    • HIDE_BUCKET_ENTITY_DATA

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BUCKET_ENTITY_DATA

    • HIDE_BLOCK_ENTITY_DATA

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BLOCK_ENTITY_DATA

    • HIDE_INSTRUMENT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_INSTRUMENT

    • HIDE_PROVIDES_TRIM_MATERIAL

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_PROVIDES_TRIM_MATERIAL

    • HIDE_OMINOUS_BOTTLE_AMPLIFIER

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_OMINOUS_BOTTLE_AMPLIFIER

    • HIDE_JUKEBOX_PLAYABLE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_JUKEBOX_PLAYABLE

    • HIDE_PROVIDES_BANNER_PATTERNS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_PROVIDES_BANNER_PATTERNS

    • HIDE_RECIPES

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_RECIPES

    • HIDE_LODESTONE_TRACKER

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_LODESTONE_TRACKER

    • HIDE_FIREWORK_EXPLOSION

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_FIREWORK_EXPLOSION

    • HIDE_FIREWORKS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_FIREWORKS

    • HIDE_PROFILE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_PROFILE

    • HIDE_NOTE_BLOCK_SOUND

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_NOTE_BLOCK_SOUND

    • HIDE_BANNER_PATTERNS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BANNER_PATTERNS

    • HIDE_BASE_COLOR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BASE_COLOR

    • HIDE_POT_DECORATIONS

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_POT_DECORATIONS

    • HIDE_CONTAINER

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CONTAINER

    • HIDE_BLOCK_STATE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BLOCK_STATE

    • HIDE_BEES

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BEES

    • HIDE_LOCK

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_LOCK

    • HIDE_CONTAINER_LOOT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CONTAINER_LOOT

    • HIDE_BREAK_SOUND

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_BREAK_SOUND

    • HIDE_VILLAGER_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_VILLAGER_VARIANT

    • HIDE_WOLF_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_WOLF_VARIANT

    • HIDE_WOLF_SOUND_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_WOLF_SOUND_VARIANT

    • HIDE_WOLF_COLLAR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_WOLF_COLLAR

    • HIDE_FOX_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_FOX_VARIANT

    • HIDE_SALMON_SIZE

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_SALMON_SIZE

    • HIDE_PARROT_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_PARROT_VARIANT

    • HIDE_TROPICAL_FISH_PATTERN

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_TROPICAL_FISH_PATTERN

    • HIDE_TROPICAL_FISH_BASE_COLOR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_TROPICAL_FISH_BASE_COLOR

    • HIDE_TROPICAL_FISH_PATTERN_COLOR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_TROPICAL_FISH_PATTERN_COLOR

    • HIDE_MOOSHROOM_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_MOOSHROOM_VARIANT

    • HIDE_RABBIT_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_RABBIT_VARIANT

    • HIDE_PIG_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_PIG_VARIANT

    • HIDE_COW_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_COW_VARIANT

    • HIDE_CHICKEN_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CHICKEN_VARIANT

    • HIDE_FROG_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_FROG_VARIANT

    • HIDE_HORSE_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_HORSE_VARIANT

    • HIDE_PAINTING_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_PAINTING_VARIANT

    • HIDE_LLAMA_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_LLAMA_VARIANT

    • HIDE_AXOLOTL_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_AXOLOTL_VARIANT

    • HIDE_CAT_VARIANT

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CAT_VARIANT

    • HIDE_CAT_COLLAR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_CAT_COLLAR

    • HIDE_SHEEP_COLOR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_SHEEP_COLOR

    • HIDE_SHULKER_COLOR

      @XInfo(since="1.21.5") public static final XItemFlag HIDE_SHULKER_COLOR

  • Field Details

    • REGISTRY

      public static final XRegistry<XItemFlag,org.bukkit.inventory.ItemFlag> REGISTRY

  • Method Details

    • values

      public static XItemFlag[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static XItemFlag valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • of

      @NotNull public static @NotNull XItemFlag of(@NotNull @NotNull org.bukkit.inventory.ItemFlag itemFlag)

    • of

      @NotNull public static @NotNull Optional<XItemFlag> of(@NotNull @NotNull String itemFlag)

    • getValues

      @NotNull public static @NotNull @Unmodifiable Collection<XItemFlag> getValues()

    • getNames

      public String[] getNames()
      Specified by:
      getNames in interface XBase<XItemFlag,org.bukkit.inventory.ItemFlag>

    • get

      @Nullable public @Nullable org.bukkit.inventory.ItemFlag get()
      Specified by:
      get in interface XBase<XItemFlag,org.bukkit.inventory.ItemFlag>

    • set

      @Contract(mutates="param1") public void set(@NotNull @NotNull org.bukkit.inventory.ItemStack item)

    • set

      @Contract(mutates="param1") public void set(@NotNull @NotNull org.bukkit.inventory.meta.ItemMeta meta)

    • removeFrom

      @Contract(mutates="param1") public void removeFrom(@NotNull @NotNull org.bukkit.inventory.ItemStack item)

    • removeFrom

      @Contract(mutates="param1") public void removeFrom(@NotNull @NotNull org.bukkit.inventory.meta.ItemMeta meta)

    • getFlags

      @Contract(value="_ -> new", pure=true) @NotNull public static @NotNull Set<XItemFlag> getFlags(@NotNull @NotNull org.bukkit.inventory.ItemStack item)

    • getFlags

      @Contract(value="_ -> new", pure=true) @NotNull public static @NotNull Set<XItemFlag> getFlags(@NotNull @NotNull org.bukkit.inventory.meta.ItemMeta meta)

    • has

      @Contract(mutates="param1") public boolean has(@NotNull @NotNull org.bukkit.inventory.ItemStack item)

    • has

      @Contract(mutates="param1") public boolean has(@NotNull @NotNull org.bukkit.inventory.meta.ItemMeta meta)

    • hideEverything

      @Deprecated @Contract(mutates="param1") public static void hideEverything(@NotNull @NotNull org.bukkit.inventory.meta.ItemMeta meta)
      Deprecated.
      The name of this method is misleading as of v1.21.5. Use decorationOnly(ItemMeta) instead.

    • decorationOnly

      @Contract(mutates="param1") public static void decorationOnly(@NotNull @NotNull org.bukkit.inventory.meta.ItemMeta meta)
      This is mostly meant for items inside GUIs. It hides everything that would be considered redundant/metadata to show to the player. For example, the item attributes, blocks it can break/place, item id, etc. There are some rare cases where some of these attributes could be considered useful even in a GUI, but not in most cases when used as decoration.
      Since:
      13.2.0