#980: Improve getArmorContents() documentation

By: Bruno Ivan <bruno@oikei.net>
This commit is contained in:
Bukkit/Spigot
2024-03-12 20:31:29 +11:00
parent 7a71ab650c
commit 3d68b13188
2 changed files with 8 additions and 4 deletions

View File

@@ -202,9 +202,11 @@ public interface EntityEquipment {
void setBoots(@Nullable ItemStack boots, boolean silent); 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 @NotNull
ItemStack[] getArmorContents(); ItemStack[] getArmorContents();

View File

@@ -10,9 +10,11 @@ import org.jetbrains.annotations.Nullable;
public interface PlayerInventory extends Inventory { 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 @NotNull
public ItemStack[] getArmorContents(); public ItemStack[] getArmorContents();