Package io.rhythmknights.coreapi.component.module.nbt

Interface NBTWrapper

All Known Implementing Classes:
LegacyNBT, PDC
public interface NBTWrapper

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getString(@NotNull org.bukkit.inventory.ItemStack itemStack, String key)
    Gets the NBT tag based on a given key.
    org.bukkit.inventory.ItemStack
    removeTag(@NotNull org.bukkit.inventory.ItemStack itemStack, String key)
    Removes a tag from an ItemStack.
    org.bukkit.inventory.ItemStack
    setBoolean(@NotNull org.bukkit.inventory.ItemStack itemStack, String key, boolean value)
    Sets a boolean to the ItemStack.
    org.bukkit.inventory.ItemStack
    setString(@NotNull org.bukkit.inventory.ItemStack itemStack, String key, String value)
    Sets an String NBT tag to the an ItemStack.

  • Method Details

    • setString

      org.bukkit.inventory.ItemStack setString(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack, String key, String value)
      Sets an String NBT tag to the an ItemStack.
      Parameters:
      itemStack - The current ItemStack to be set.
      key - The NBT key to use.
      value - The tag value to set.
      Returns:
      An ItemStack that has NBT set.

    • removeTag

      org.bukkit.inventory.ItemStack removeTag(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack, String key)
      Removes a tag from an ItemStack.
      Parameters:
      itemStack - The current ItemStack to be remove.
      key - The NBT key to remove.
      Returns:
      An ItemStack that has the tag removed.

    • setBoolean

      org.bukkit.inventory.ItemStack setBoolean(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack, String key, boolean value)
      Sets a boolean to the ItemStack. Mainly used for setting an item to be unbreakable on older versions.
      Parameters:
      itemStack - The ItemStack to set the boolean to.
      key - The key to use.
      value - The boolean value.
      Returns:
      An ItemStack with a boolean value set.

    • getString

      @Nullable @Nullable String getString(@NotNull @NotNull org.bukkit.inventory.ItemStack itemStack, String key)
      Gets the NBT tag based on a given key.
      Parameters:
      itemStack - The ItemStack to get from.
      key - The key to look for.
      Returns:
      The tag that was stored in the ItemStack.