From 3d68b131884db5e292eed51f472c609ba12d0eef Mon Sep 17 00:00:00 2001 From: Bukkit/Spigot <noreply+git-bukkit@papermc.io> Date: Tue, 12 Mar 2024 20:31:29 +1100 Subject: [PATCH] #980: Improve getArmorContents() documentation By: Bruno Ivan <bruno@oikei.net> --- .../src/main/java/org/bukkit/inventory/EntityEquipment.java | 6 ++++-- .../src/main/java/org/bukkit/inventory/PlayerInventory.java | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java b/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java index d5b50a4a95..9adc827bc5 100644 --- a/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java +++ b/paper-api/src/main/java/org/bukkit/inventory/EntityEquipment.java @@ -202,9 +202,11 @@ public interface EntityEquipment { void setBoots(@Nullable ItemStack boots, boolean silent); /** - * Gets a copy of all worn armor + * Gets all ItemStacks from the armor slots. * - * @return The array of worn armor. Individual items may be null. + * @return all the ItemStacks from the armor slots. Individual items can be + * null and are returned in a fixed order starting from the boots and going + * up to the helmet */ @NotNull ItemStack[] getArmorContents(); diff --git a/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java b/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java index 62fbd7f6d8..f1918027c3 100644 --- a/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java +++ b/paper-api/src/main/java/org/bukkit/inventory/PlayerInventory.java @@ -10,9 +10,11 @@ import org.jetbrains.annotations.Nullable; public interface PlayerInventory extends Inventory { /** - * Get all ItemStacks from the armor slots + * Gets all ItemStacks from the armor slots. * - * @return All the ItemStacks from the armor slots. Individual items can be null. + * @return all the ItemStacks from the armor slots. Individual items can be + * null and are returned in a fixed order starting from the boots and going + * up to the helmet */ @NotNull public ItemStack[] getArmorContents();