Package dev.lone.itemsadder.api

Class CustomStack

java.lang.Object
dev.lone.itemsadder.api.CustomStack
Direct Known Subclasses:
CustomBlock, CustomFire, CustomFurniture
public class CustomStack extends Object
Allows the creation and retrieval of cutom Item Stacks.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomStack()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable CustomStack
    byItemStack(org.bukkit.inventory.ItemStack itemStack)
    Returns null if the provided ItemStack is not a custom item created with ItemsAdder.
    boolean
    drop(org.bukkit.Location loc)
    Tries to drop the CustomStack at the provided location.
    org.bukkit.configuration.file.FileConfiguration
    getConfig()
    Gets a FileConfiguration instance for this CustomStack.
    String
    getConfigPath()
    Gets the path towards the configuration file of this CustomStack.
    double
    getDamageMainhand()
    Gets the damage value of the main hand for this CustomStack.
    String
    getDisplayName()
    Gets the displayed name of this CustomStack.
    int
    getDurability()
    Gets the current amount of durability of this CustomStack.
    String
    getId()
    Gets the id used for this CustomStack instance.
    static @Nullable CustomStack
    getInstance(String namespacedID)
    Gets a clone of the custom stack declared in ItemsAdder registry.
    org.bukkit.inventory.ItemStack
    getItemStack()
    Gets the Bukkit ItemStack associated with this CustomStack instance.
    int
    getMaxDurability()
    Gets the maximum custom durability of this CustomStack.
    String
    getModelPath()
    Gets the path towards the model used for this CustomStack.
    String
    getNamespace()
    Gets the namespace used for this CustomStack instance.
    String
    getNamespacedID()
    Gets the namespace and id of this CustomStack instance in the format namespace:id
    static Set<String>
    getNamespacedIdsInRegistry()
    Returns a list of all the registered items identifiers in the format namespace:id
    @Nullable String
    getPermission()
    Gets the permission associated with this CustomStack.
    List<String>
    getTextures()
    Gets a list of Textures of this CustomStack.
    int
    getUsages()
    Gets the amount of usages for this CustomStack.
    boolean
    hasAutoGeneratedModel()
    Returns whether this CustomStack has a auto-generated model.
    boolean
    hasCustomDurability()
    Returns whether this CustomStack has a custom durability applied.
    boolean
    hasPermission()
    Returns whether this CustomStack instance has a permission associated with it.
    boolean
    hasUsagesAttribute()
    Returns whether this CustomStack has a usages attribute applied.
    boolean
    isBlock()
    Returns if this CustomStack is actually a Block.
    boolean
    isBlockAllEnchants()
    Returns if this CustomStack blocks all enchantings.
    static boolean
    isInRegistry(String namespacedId)
    Returns true if the registry contains an item with the specified namespaced id in the format namespace:id
    boolean
    matchNamespacedID(CustomStack other)
    Returns whether the namespace and id of the provided CustomStack match the one of this CustomStack.
    void
    reduceUsages(int amount)
    Reduces the amount of usages from this CustomStack by the provided interger.
    void
    setAttributeModifier(String attributeModifier, String slotStr, double value)
    Sets the different attributes for this CustomStack.
    void
    setDisplayName(String displayName)
    Sets the displayed name of this CustomStack.
    void
    setDurability(int durability)
    Sets the custom durability of this CustomStack to the provided integer.
    void
    setMaxDurability(int maxDurability)
    Sets the custom max durability of this CustomStack to the provided integer.
    void
    setUsages(int amount)
    Sets the amount of usages for this CustomStack to the provided integer.
    void
    updateAttackDamageLore(String slot)
    Use this if you change attack damage of the item (via enchant or attribute modifier)
    void
    updateAttackSpeedLore(String slot)
    Use this if you change attack speed of the item

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CustomStack

      public CustomStack()

  • Method Details

    • getNamespacedIdsInRegistry

      public static Set<String> getNamespacedIdsInRegistry()
      Returns a list of all the registered items identifiers in the format namespace:id
      Returns:
      a list of Namespaces and IDs in the format namespace:id

    • isInRegistry

      public static boolean isInRegistry(String namespacedId)
      Returns true if the registry contains an item with the specified namespaced id in the format namespace:id
      Parameters:
      namespacedId - Namespace and ID in the format namespace:id
      Returns:
      true if it contains the namespaced id, otherwise false

    • byItemStack

      @Nullable public static @Nullable CustomStack byItemStack(org.bukkit.inventory.ItemStack itemStack)
      Returns null if the provided ItemStack is not a custom item created with ItemsAdder.
      Parameters:
      itemStack - the Bukkit ItemStack to get the custom Item Stack from.
      Returns:
      Possibly-null CustomStack instance.

    • getInstance

      @Nullable public static @Nullable CustomStack getInstance(String namespacedID)
      Gets a clone of the custom stack declared in ItemsAdder registry.
      May return null if the provided namespace and id don't belong to a registered custom Item.

      You can give this to a player and do whatever you want without overwriting the original item.

      Parameters:
      namespacedID - The ID in the format namespace:id to get the CustomStack-copy from.
      Returns:
      Possibly-null copy of a CustomStack instance.

    • getItemStack

      public org.bukkit.inventory.ItemStack getItemStack()
      Gets the Bukkit ItemStack associated with this CustomStack instance.
      Returns:
      Bukkit ItemStack used for this CustomStack.

    • getNamespace

      public String getNamespace()
      Gets the namespace used for this CustomStack instance.
      Returns:
      String representing the namespace of the CustomStack.

    • getId

      public String getId()
      Gets the id used for this CustomStack instance.
      Returns:
      String representing the id of the CustomStack.

    • getNamespacedID

      public String getNamespacedID()
      Gets the namespace and id of this CustomStack instance in the format namespace:id
      Returns:
      String representing namespace and id of the CustomStack.

    • getModelPath

      public String getModelPath()
      Gets the path towards the model used for this CustomStack.
      Returns:
      String representing the path to the CustomStack's model.

    • getConfigPath

      public String getConfigPath()
      Gets the path towards the configuration file of this CustomStack.
      Returns:
      String representing the path towards the CustomStack's configuration.

    • getConfig

      public org.bukkit.configuration.file.FileConfiguration getConfig()
      Gets a FileConfiguration instance for this CustomStack.
      Returns:
      FileConfiguration for the CustomStack.

    • getPermission

      @Nullable public @Nullable String getPermission()
      Gets the permission associated with this CustomStack.
      Returns:
      Possibly-null String representing the permission for this CustomStack.

    • hasPermission

      public boolean hasPermission()
      Returns whether this CustomStack instance has a permission associated with it.
      Returns:
      true if a permission was set for this CustomStack, otherwise false.

    • matchNamespacedID

      public boolean matchNamespacedID(CustomStack other)
      Returns whether the namespace and id of the provided CustomStack match the one of this CustomStack.
      Parameters:
      other - the CustomStack to check the namespace and id against.
      Returns:
      true if namespace and id match, otherwise false.

    • hasAutoGeneratedModel

      public boolean hasAutoGeneratedModel()
      Returns whether this CustomStack has a auto-generated model.
      Returns:
      true if the CustomStack has a auto-generated model, otherwise false.

    • getTextures

      public List<String> getTextures()
      Gets a list of Textures of this CustomStack.
      Returns:
      list containing Strings representing the CustomStack's textures.

    • isBlockAllEnchants

      public boolean isBlockAllEnchants()
      Returns if this CustomStack blocks all enchantings.
      Returns:
      true if it blocks all enchantings, otherwise false.

    • hasUsagesAttribute

      public boolean hasUsagesAttribute()
      Returns whether this CustomStack has a usages attribute applied.
      Returns:
      true if the CustomStack has a usage attribute applied, otherwise false.

    • setUsages

      public void setUsages(int amount)
      Sets the amount of usages for this CustomStack to the provided integer.
      Parameters:
      amount - the amount of usages to set for this CustomStack.

    • reduceUsages

      public void reduceUsages(int amount)
      Reduces the amount of usages from this CustomStack by the provided interger.
      Parameters:
      amount - the amount of usages to remove from this CustomStack.

    • getUsages

      public int getUsages()
      Gets the amount of usages for this CustomStack.
      Returns:
      int representing the amount of usages remaining.

    • hasCustomDurability

      public boolean hasCustomDurability()
      Returns whether this CustomStack has a custom durability applied.
      Returns:
      true if the CustomStack has custom durability applied, otherwise false.

    • getDurability

      public int getDurability()
      Gets the current amount of durability of this CustomStack.
      Returns:
      int representing the current durability of the CustomStack.

    • setDurability

      public void setDurability(int durability)
      Sets the custom durability of this CustomStack to the provided integer.
      Parameters:
      durability - The durability to set for this CustomStack.

    • setMaxDurability

      public void setMaxDurability(int maxDurability)
      Sets the custom max durability of this CustomStack to the provided integer.
      Parameters:
      maxDurability - The max durability to set for this CustomStack.

    • getMaxDurability

      public int getMaxDurability()
      Gets the maximum custom durability of this CustomStack.
      Returns:
      Integer representing the total custom durability of the CustomStack.

    • setAttributeModifier

      public void setAttributeModifier(String attributeModifier, String slotStr, double value)
      Sets the different attributes for this CustomStack.

      A full list of available attributes can be found on the Minecraft Gamepedia Wiki.
      You do not have to provide the generic. prefix for the attribute!

      Not all attributes are available on all Minecraft versions!

      Example

      
 item.setAttributeModifier("attack_damage", "mainhand", 10d);
      Parameters:
      attributeModifier - The attribute to modify. Does not need the generic. prefix.
      slotStr - The slot to apply it to. Can be mainhand, offhand, head, chest, legs or feet.
      value - The value to set for the attribute.

    • setDisplayName

      public void setDisplayName(String displayName)
      Sets the displayed name of this CustomStack.
      Parameters:
      displayName - The display name to set for this CustomStack.

    • getDisplayName

      public String getDisplayName()
      Gets the displayed name of this CustomStack.
      Returns:
      String representing the display name of the CustomStack.

    • getDamageMainhand

      public double getDamageMainhand()
      Gets the damage value of the main hand for this CustomStack.
      Returns:
      Double representing the damage for the main hand.

    • updateAttackDamageLore

      public void updateAttackDamageLore(String slot)
      Use this if you change attack damage of the item (via enchant or attribute modifier)
      Parameters:
      slot - The slot to apply the String to. Can be mainhand, offhand, head, chest, legs or feet.

    • updateAttackSpeedLore

      public void updateAttackSpeedLore(String slot)
      Use this if you change attack speed of the item
      Parameters:
      slot - The slot to apply the String to. Can be mainhand, offhand, head, chest, legs or feet.

    • isBlock

      public boolean isBlock()
      Returns if this CustomStack is actually a Block.
      Returns:
      true if the CustomStack is a block, otherwise false.

    • drop

      public boolean drop(org.bukkit.Location loc)
      Tries to drop the CustomStack at the provided location.
      Parameters:
      loc - The location to drop the CustomStack at.
      Returns:
      true if the CustomStack was dropped, otherwise false.