Package org.bukkit.inventory

Interface EntityEquipment

  • public interface EntityEquipment
    An interface to a creatures inventory

    • Method Detail

      • getItemInMainHand

        @NotNull
ItemStack getItemInMainHand()
        Gets a copy of the item the entity is currently holding in their main hand.
        Returns:
        the currently held item

      • setItemInMainHand

        void setItemInMainHand​(@Nullable
                       ItemStack item)
        Sets the item the entity is holding in their main hand.
        Parameters:
        item - The item to put into the entities hand

      • getItemInOffHand

        @NotNull
ItemStack getItemInOffHand()
        Gets a copy of the item the entity is currently holding in their off hand.
        Returns:
        the currently held item

      • setItemInOffHand

        void setItemInOffHand​(@Nullable
                      ItemStack item)
        Sets the item the entity is holding in their off hand.
        Parameters:
        item - The item to put into the entities hand

      • getItemInHand

        @Deprecated
@NotNull
ItemStack getItemInHand()
        Deprecated.
        entities can duel wield now use the methods for the specific hand instead
        Gets a copy of the item the entity is currently holding
        Returns:
        the currently held item
        See Also:
        getItemInMainHand(), getItemInOffHand()

      • getHelmet

        @Nullable
ItemStack getHelmet()
        Gets a copy of the helmet currently being worn by the entity
        Returns:
        The helmet being worn

      • setHelmet

        void setHelmet​(@Nullable
               ItemStack helmet)
        Sets the helmet worn by the entity
        Parameters:
        helmet - The helmet to put on the entity

      • getChestplate

        @Nullable
ItemStack getChestplate()
        Gets a copy of the chest plate currently being worn by the entity
        Returns:
        The chest plate being worn

      • setChestplate

        void setChestplate​(@Nullable
                   ItemStack chestplate)
        Sets the chest plate worn by the entity
        Parameters:
        chestplate - The chest plate to put on the entity

      • getLeggings

        @Nullable
ItemStack getLeggings()
        Gets a copy of the leggings currently being worn by the entity
        Returns:
        The leggings being worn

      • setLeggings

        void setLeggings​(@Nullable
                 ItemStack leggings)
        Sets the leggings worn by the entity
        Parameters:
        leggings - The leggings to put on the entity

      • getBoots

        @Nullable
ItemStack getBoots()
        Gets a copy of the boots currently being worn by the entity
        Returns:
        The boots being worn

      • setBoots

        void setBoots​(@Nullable
              ItemStack boots)
        Sets the boots worn by the entity
        Parameters:
        boots - The boots to put on the entity

      • getArmorContents

        @NotNull
ItemStack[] getArmorContents()
        Gets a copy of all worn armor
        Returns:
        The array of worn armor. Individual items may be null.

      • setArmorContents

        void setArmorContents​(@NotNull
                      ItemStack[] items)
        Sets the entities armor to the provided array of ItemStacks
        Parameters:
        items - The items to set the armor as. Individual items may be null.

      • clear

        void clear()
        Clears the entity of all armor and held items

      • getItemInMainHandDropChance

        float getItemInMainHandDropChance()
        Gets the chance of the main hand item being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Returns:
        chance of the currently held item being dropped (1 for players)

      • setItemInMainHandDropChance

        void setItemInMainHandDropChance​(float chance)
        Sets the chance of the item this creature is currently holding in their main hand being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Parameters:
        chance - the chance of the main hand item being dropped
        Throws:
        UnsupportedOperationException - when called on players

      • getItemInOffHandDropChance

        float getItemInOffHandDropChance()
        Gets the chance of the off hand item being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Returns:
        chance of the off hand item being dropped (1 for players)

      • setItemInOffHandDropChance

        void setItemInOffHandDropChance​(float chance)
        Sets the chance of the off hand item being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Parameters:
        chance - the chance of off hand item being dropped
        Throws:
        UnsupportedOperationException - when called on players

      • getHelmetDropChance

        float getHelmetDropChance()
        Gets the chance of the helmet being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Returns:
        the chance of the helmet being dropped (1 for players)

      • setHelmetDropChance

        void setHelmetDropChance​(float chance)
        Sets the chance of the helmet being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Parameters:
        chance - of the helmet being dropped
        Throws:
        UnsupportedOperationException - when called on players

      • getChestplateDropChance

        float getChestplateDropChance()
        Gets the chance of the chest plate being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Returns:
        the chance of the chest plate being dropped (1 for players)

      • setChestplateDropChance

        void setChestplateDropChance​(float chance)
        Sets the chance of the chest plate being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Parameters:
        chance - of the chest plate being dropped
        Throws:
        UnsupportedOperationException - when called on players

      • getLeggingsDropChance

        float getLeggingsDropChance()
        Gets the chance of the leggings being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Returns:
        the chance of the leggings being dropped (1 for players)

      • setLeggingsDropChance

        void setLeggingsDropChance​(float chance)
        Sets the chance of the leggings being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Parameters:
        chance - chance of the leggings being dropped
        Throws:
        UnsupportedOperationException - when called on players

      • getBootsDropChance

        float getBootsDropChance()
        Gets the chance of the boots being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Returns:
        the chance of the boots being dropped (1 for players)

      • setBootsDropChance

        void setBootsDropChance​(float chance)
        Sets the chance of the boots being dropped upon this creature's death.
        • A drop chance of 0.0F will never drop
        • A drop chance of 1.0F will always drop
        Parameters:
        chance - of the boots being dropped
        Throws:
        UnsupportedOperationException - when called on players

      • getHolder

        @Nullable
Entity getHolder()
        Get the entity this EntityEquipment belongs to
        Returns:
        the entity this EntityEquipment belongs to