From 9fb611dc9f3489629214f4962308ef498358ccc9 Mon Sep 17 00:00:00 2001 From: willies952002 Date: Thu, 26 Jul 2018 02:22:44 -0400 Subject: [PATCH] Expand ArmorStand API Add the following: - Add proper methods for getting and setting items in both hands. Deprecates old methods - Enable/Disable slot interactions diff --git a/src/main/java/org/bukkit/entity/ArmorStand.java b/src/main/java/org/bukkit/entity/ArmorStand.java index 492df420..e7f71e65 100644 --- a/src/main/java/org/bukkit/entity/ArmorStand.java +++ b/src/main/java/org/bukkit/entity/ArmorStand.java @@ -1,5 +1,6 @@ package org.bukkit.entity; +import org.bukkit.inventory.EquipmentSlot; import org.bukkit.inventory.ItemStack; import org.bukkit.util.EulerAngle; import org.jetbrains.annotations.NotNull; @@ -12,8 +13,13 @@ public interface ArmorStand extends LivingEntity { * currently holding * * @return the held item + // Paper start - Deprecate in favor of setItemInMainHand + * @deprecated use {@link ArmorStand#getItem(EquipmentSlot)} instead + * @see ArmorStand#getItem(EquipmentSlot) + // Paper end */ @NotNull + @Deprecated // Paper ItemStack getItemInHand(); /** @@ -21,7 +27,12 @@ public interface ArmorStand extends LivingEntity { * holding * * @param item the item to hold + // Paper start - Deprecate in favor of setItemInMainHand + * @deprecated use {@link ArmorStand#setItem(EquipmentSlot, ItemStack)} instead + * @see ArmorStand#setItem(EquipmentSlot, ItemStack) + // Paper end */ + @Deprecated // Paper void setItemInHand(@Nullable ItemStack item); /** @@ -304,5 +315,71 @@ public interface ArmorStand extends LivingEntity { * @param tick {@code true} if this armour stand can tick, {@code false} otherwise */ void setCanTick(final boolean tick); + + /** + * Returns the item the armor stand has + * equip in the given equipment slot + * + * @param slot the equipment slot to get + * @return the ItemStack in the equipment slot + */ + @NotNull + ItemStack getItem(@NotNull final org.bukkit.inventory.EquipmentSlot slot); + + /** + * Sets the item the armor stand has + * equip in the given equipment slot + * + * @param slot the equipment slot to set + * @param item the item to hold + */ + void setItem(@NotNull final org.bukkit.inventory.EquipmentSlot slot, @Nullable final ItemStack item); + + /** + * Get the list of disabled slots + * + * @return list of disabled slots + */ + @NotNull + java.util.Set getDisabledSlots(); + + /** + * Set the disabled slots + * + * This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s) + * Note: Once a slot is disabled, the only way to get an item back it to break the armor stand. + * + * @param slots var-arg array of slots to lock + */ + void setDisabledSlots(@NotNull org.bukkit.inventory.EquipmentSlot... slots); + + /** + * Disable specific slots, adding them + * to the currently disabled slots + * + * This makes it so a player is unable to interact with the Armor Stand to place, remove, or replace an item in the given slot(s) + * Note: Once a slot is disabled, the only way to get an item back it to break the armor stand. + * + * @param slots var-arg array of slots to lock + */ + void addDisabledSlots(@NotNull final org.bukkit.inventory.EquipmentSlot... slots); + + /** + * Remove the given slots from the disabled + * slots list, enabling them. + * + * This makes it so a player is able to interact with the Armor Stand to place, remove, or replace an item in the given slot(s) + * + * @param slots var-arg array of slots to unlock + */ + void removeDisabledSlots(@NotNull final org.bukkit.inventory.EquipmentSlot... slots); + + /** + * Check if a specific slot is disabled + * + * @param slot The slot to check + * @return {@code true} if the slot is disabled, else {@code false}. + */ + boolean isSlotDisabled(@NotNull org.bukkit.inventory.EquipmentSlot slot); // Paper end } -- 2.21.0