Spigot / Bukkit / 6f9fe1d936f

Commits

Parker Hawke authored and md_5 committed 6f9fe1d936f 21 Dec 2020

#562: Add API to set equipment silently

src/main/java/org/bukkit/inventory/EntityEquipment.java

Modified

-10
+public interface EntityEquipment {
-11
-12
+    /**
-13
+     * Stores the ItemStack at the given equipment slot in the inventory.
-14
+     *
-15
+     * @param slot the slot to put the ItemStack
-16
+     * @param item the ItemStack to set
-17
+     */
-18
+    public void setItem(@NotNull EquipmentSlot slot, @Nullable ItemStack item);
-19
-+
+    /**
-+
+     * Stores the ItemStack at the given equipment slot in the inventory.
-+
+     *
-+
+     * @param slot the slot to put the ItemStack
-+
+     * @param item the ItemStack to set
-+
+     * @param silent whether or not the equip sound should be silenced
-+
+     */
-+
+    public void setItem(@NotNull EquipmentSlot slot, @Nullable ItemStack item, boolean silent);
-+
-29
+    /**
-30
+     * Gets the ItemStack at the given equipment slot in the inventory.
-31
+     *
-32
+     * @param slot the slot to get the ItemStack
-33
+     * @return the ItemStack in the given slot
-34
+     */
-35
+    @NotNull
-36
+    public ItemStack getItem(@NotNull EquipmentSlot slot);
-37
-38
+    /**
-44
+    @NotNull
-45
+    ItemStack getItemInMainHand();
-46
-47
+    /**
-48
+     * Sets the item the entity is holding in their main hand.
-49
+     *
-50
+     * @param item The item to put into the entities hand
-51
+     */
-52
+    void setItemInMainHand(@Nullable ItemStack item);
-53
-+
+    /**
-+
+     * Sets the item the entity is holding in their main hand.
-+
+     *
-+
+     * @param item The item to put into the entities hand
-+
+     * @param silent whether or not the equip sound should be silenced
-+
+     */
-+
+    void setItemInMainHand(@Nullable ItemStack item, boolean silent);
-+
-62
+    /**
-63
+     * Gets a copy of the item the entity is currently holding
-64
+     * in their off hand.
-65
+     *
-66
+     * @return the currently held item
-67
+     */
-68
+    @NotNull
-69
+    ItemStack getItemInOffHand();
-70
-71
+    /**
-72
+     * Sets the item the entity is holding in their off hand.
-73
+     *
-74
+     * @param item The item to put into the entities hand
-75
+     */
-76
+    void setItemInOffHand(@Nullable ItemStack item);
-77
-+
+    /**
-+
+     * Sets the item the entity is holding in their off hand.
-+
+     *
-+
+     * @param item The item to put into the entities hand
-+
+     * @param silent whether or not the equip sound should be silenced
-+
+     */
-+
+    void setItemInOffHand(@Nullable ItemStack item, boolean silent);
-+
-86
+    /**
-87
+     * Gets a copy of the item the entity is currently holding
-88
+     *
-89
+     * @deprecated entities can duel wield now use the methods for the
-90
+     *      specific hand instead
-91
+     * @see #getItemInMainHand()
-92
+     * @see #getItemInOffHand()
-93
+     * @return the currently held item
-94
+     */
-95
+    @Deprecated
-116
+    @Nullable
-117
+    ItemStack getHelmet();
-118
-119
+    /**
-120
+     * Sets the helmet worn by the entity
-121
+     *
-122
+     * @param helmet The helmet to put on the entity
-123
+     */
-124
+    void setHelmet(@Nullable ItemStack helmet);
-125
-+
+    /**
-+
+     * Sets the helmet worn by the entity
-+
+     *
-+
+     * @param helmet The helmet to put on the entity
-+
+     * @param silent whether or not the equip sound should be silenced
-+
+     */
-+
+    void setHelmet(@Nullable ItemStack helmet, boolean silent);
-+
-134
+    /**
-135
+     * Gets a copy of the chest plate currently being worn by the entity
-136
+     *
-137
+     * @return The chest plate being worn
-138
+     */
-139
+    @Nullable
-140
+    ItemStack getChestplate();
-141
-142
+    /**
-143
+     * Sets the chest plate worn by the entity
-144
+     *
-145
+     * @param chestplate The chest plate to put on the entity
-146
+     */
-147
+    void setChestplate(@Nullable ItemStack chestplate);
-148
-+
+    /**
-+
+     * Sets the chest plate worn by the entity
-+
+     *
-+
+     * @param chestplate The chest plate to put on the entity
-+
+     * @param silent whether or not the equip sound should be silenced
-+
+     */
-+
+    void setChestplate(@Nullable ItemStack chestplate, boolean silent);
-+
-157
+    /**
-158
+     * Gets a copy of the leggings currently being worn by the entity
-159
+     *
-160
+     * @return The leggings being worn
-161
+     */
-162
+    @Nullable
-163
+    ItemStack getLeggings();
-164
-165
+    /**
-166
+     * Sets the leggings worn by the entity
-167
+     *
-168
+     * @param leggings The leggings to put on the entity
-169
+     */
-170
+    void setLeggings(@Nullable ItemStack leggings);
-171
-+
+    /**
-+
+     * Sets the leggings worn by the entity
-+
+     *
-+
+     * @param leggings The leggings to put on the entity
-+
+     * @param silent whether or not the equip sound should be silenced
-+
+     */
-+
+    void setLeggings(@Nullable ItemStack leggings, boolean silent);
-+
-180
+    /**
-181
+     * Gets a copy of the boots currently being worn by the entity
-182
+     *
-183
+     * @return The boots being worn
-184
+     */
-185
+    @Nullable
-186
+    ItemStack getBoots();
-187
-188
+    /**
-189
+     * Sets the boots worn by the entity
-190
+     *
-191
+     * @param boots The boots to put on the entity
-192
+     */
-193
+    void setBoots(@Nullable ItemStack boots);
-194
-+
+    /**
-+
+     * Sets the boots worn by the entity
-+
+     *
-+
+     * @param boots The boots to put on the entity
-+
+     * @param silent whether or not the equip sound should be silenced
-+
+     */
-+
+    void setBoots(@Nullable ItemStack boots, boolean silent);
-+
-203
+    /**
-204
+     * Gets a copy of all worn armor
-205
+     *
-206
+     * @return The array of worn armor. Individual items may be null.
-207
+     */
-208
+    @NotNull
-209
+    ItemStack[] getArmorContents();
-210
-211
+    /**
-212
+     * Sets the entities armor to the provided array of ItemStacks

Bukkit

Commits

Jira Issues

Add shortcut