Fix EntityEquipment and related javadocs (#7380)
This commit is contained in:
parent
f210f67c4a
commit
3f7111d4e1
3 changed files with 271 additions and 14 deletions
|
@ -124,16 +124,248 @@ index 1119e26e270bb45f517955b19d95a9ec3d113634..4631647c64c89ffdde2d9b63bdab974a
|
|||
* @param sz The new size of the slime.
|
||||
*/
|
||||
public void setSize(int sz);
|
||||
diff --git a/src/main/java/org/bukkit/event/player/PlayerMoveEvent.java b/src/main/java/org/bukkit/event/player/PlayerMoveEvent.java
|
||||
index 1b2267f4e8ebded198773ec80e2bff2c861c7084..1a58734d919fae247eeb85dd785fd59990856505 100644
|
||||
--- a/src/main/java/org/bukkit/event/player/PlayerMoveEvent.java
|
||||
+++ b/src/main/java/org/bukkit/event/player/PlayerMoveEvent.java
|
||||
@@ -78,7 +78,7 @@ public class PlayerMoveEvent extends PlayerEvent implements Cancellable {
|
||||
diff --git a/src/main/java/org/bukkit/inventory/EntityEquipment.java b/src/main/java/org/bukkit/inventory/EntityEquipment.java
|
||||
index d5b50a4a954fed35d37f03f1a277cc173ca106df..a91fa5386afd7a1137adb921ad5adb798604772f 100644
|
||||
--- a/src/main/java/org/bukkit/inventory/EntityEquipment.java
|
||||
+++ b/src/main/java/org/bukkit/inventory/EntityEquipment.java
|
||||
@@ -37,9 +37,23 @@ public interface EntityEquipment {
|
||||
public ItemStack getItem(@NotNull EquipmentSlot slot);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the item the entity is currently holding
|
||||
+ * Gets the item the entity is currently holding
|
||||
* in their main hand.
|
||||
*
|
||||
* @return Location the player moved to
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player,
|
||||
+ * or it's an empty stack (has AIR as its type).
|
||||
+ * For non-empty stacks from players, this returns a live mirror. You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getItemInMainHand(); // will return a mirror
|
||||
+ * } else {
|
||||
+ * equipment.getItemInMainHand(); // will return a copy
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
+ *
|
||||
* @return the currently held item
|
||||
*/
|
||||
@NotNull
|
||||
@@ -61,9 +75,23 @@ public interface EntityEquipment {
|
||||
void setItemInMainHand(@Nullable ItemStack item, boolean silent);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the item the entity is currently holding
|
||||
+ * Gets the item the entity is currently holding
|
||||
* in their off hand.
|
||||
*
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player,
|
||||
+ * or it's an empty stack (has AIR as its type).
|
||||
+ * For non-empty stacks from players, this returns a live mirror. You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getItemInOffHand(); // will return a mirror
|
||||
+ * } else {
|
||||
+ * equipment.getItemInOffHand(); // will return a copy
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
+ *
|
||||
* @return the currently held item
|
||||
*/
|
||||
@NotNull
|
||||
@@ -85,7 +113,21 @@ public interface EntityEquipment {
|
||||
void setItemInOffHand(@Nullable ItemStack item, boolean silent);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the item the entity is currently holding
|
||||
+ * Gets the item the entity is currently holding
|
||||
+ *
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player,
|
||||
+ * or it's an empty stack (has AIR as its type).
|
||||
+ * For non-empty stacks from players, this returns a live mirror. You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getItemInHand(); // will return a mirror
|
||||
+ * } else {
|
||||
+ * equipment.getItemInHand(); // will return a copy
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
*
|
||||
* @return the currently held item
|
||||
* @see #getItemInMainHand()
|
||||
@@ -110,11 +152,24 @@ public interface EntityEquipment {
|
||||
void setItemInHand(@Nullable ItemStack stack);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the helmet currently being worn by the entity
|
||||
+ * Gets the helmet currently being worn by the entity
|
||||
+ *
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player.
|
||||
+ * For stacks from players, this returns a live mirror (or null). You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getItemInHand(); // will return a mirror
|
||||
+ * } else {
|
||||
+ * equipment.getItemInHand(); // will return a copy
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
*
|
||||
* @return The helmet being worn
|
||||
*/
|
||||
- @Nullable
|
||||
+ @NotNull // Paper
|
||||
public Location getTo() {
|
||||
return to;
|
||||
}
|
||||
+ @org.bukkit.UndefinedNullability("not null for entities, nullable for players") // Paper
|
||||
ItemStack getHelmet();
|
||||
|
||||
/**
|
||||
@@ -133,11 +188,24 @@ public interface EntityEquipment {
|
||||
void setHelmet(@Nullable ItemStack helmet, boolean silent);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the chest plate currently being worn by the entity
|
||||
+ * Gets the chest plate currently being worn by the entity
|
||||
+ *
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player.
|
||||
+ * For stacks from players, this returns a live mirror (or null). You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getChestplate(); // will return a mirror
|
||||
+ * } else {
|
||||
+ * equipment.getChestplate(); // will return a copy
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
*
|
||||
* @return The chest plate being worn
|
||||
*/
|
||||
- @Nullable
|
||||
+ @org.bukkit.UndefinedNullability("not null for entities, nullable for players") // Paper
|
||||
ItemStack getChestplate();
|
||||
|
||||
/**
|
||||
@@ -156,11 +224,24 @@ public interface EntityEquipment {
|
||||
void setChestplate(@Nullable ItemStack chestplate, boolean silent);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the leggings currently being worn by the entity
|
||||
+ * Gets the leggings currently being worn by the entity
|
||||
+ *
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player.
|
||||
+ * For stacks from players, this returns a live mirror (or null). You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getLeggings(); // will return a mirror
|
||||
+ * } else {
|
||||
+ * equipment.getLeggings(); // will return a copy
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
*
|
||||
* @return The leggings being worn
|
||||
*/
|
||||
- @Nullable
|
||||
+ @org.bukkit.UndefinedNullability("not null for entities, nullable for players") // Paper
|
||||
ItemStack getLeggings();
|
||||
|
||||
/**
|
||||
@@ -179,11 +260,24 @@ public interface EntityEquipment {
|
||||
void setLeggings(@Nullable ItemStack leggings, boolean silent);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the boots currently being worn by the entity
|
||||
+ * Gets the boots currently being worn by the entity
|
||||
+ *
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player.
|
||||
+ * For stacks from players, this returns a live mirror (or null). You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getBoots(); // will return a mirror
|
||||
+ * } else {
|
||||
+ * equipment.getBoots(); // will return a copy
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
*
|
||||
* @return The boots being worn
|
||||
*/
|
||||
- @Nullable
|
||||
+ @org.bukkit.UndefinedNullability("not null for entities, nullable for players") // Paper
|
||||
ItemStack getBoots();
|
||||
|
||||
/**
|
||||
@@ -202,12 +296,25 @@ public interface EntityEquipment {
|
||||
void setBoots(@Nullable ItemStack boots, boolean silent);
|
||||
|
||||
/**
|
||||
- * Gets a copy of all worn armor
|
||||
+ * Gets all worn armor
|
||||
+ *
|
||||
+ * <p>
|
||||
+ * This returns a copy if this equipment instance is from a non-player,
|
||||
+ * or it's an empty stack (has AIR as its type).
|
||||
+ * For non-empty stacks from players, this returns a live mirror. You can check if this
|
||||
+ * will return a mirror with
|
||||
+ * <pre>{@code
|
||||
+ * EntityEquipment equipment = entity.getEquipment();
|
||||
+ * if (equipment instanceof PlayerInventory) {
|
||||
+ * equipment.getArmorContents(); // will return an array of mirror
|
||||
+ * } else {
|
||||
+ * equipment.getArmorContents(); // will return an array of copies
|
||||
+ * }
|
||||
+ * }</pre>
|
||||
*
|
||||
* @return The array of worn armor. Individual items may be null.
|
||||
*/
|
||||
- @NotNull
|
||||
- ItemStack[] getArmorContents();
|
||||
+ @org.bukkit.UndefinedNullability("not null elements for entities, nullable elements for players") ItemStack @NotNull [] getArmorContents(); // Paper
|
||||
|
||||
/**
|
||||
* Sets the entities armor to the provided array of ItemStacks
|
||||
diff --git a/src/main/java/org/bukkit/inventory/PlayerInventory.java b/src/main/java/org/bukkit/inventory/PlayerInventory.java
|
||||
index 62fbd7f6d8195bebcab7f704a0a485a1bbeca26c..5461f7fa75f5a065bb333b4a113640b5fe1e3825 100644
|
||||
--- a/src/main/java/org/bukkit/inventory/PlayerInventory.java
|
||||
+++ b/src/main/java/org/bukkit/inventory/PlayerInventory.java
|
||||
@@ -158,7 +158,7 @@ public interface PlayerInventory extends Inventory {
|
||||
public void setBoots(@Nullable ItemStack boots);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the item the player is currently holding
|
||||
+ * Gets the item the player is currently holding
|
||||
* in their main hand.
|
||||
*
|
||||
* @return the currently held item
|
||||
@@ -174,7 +174,7 @@ public interface PlayerInventory extends Inventory {
|
||||
void setItemInMainHand(@Nullable ItemStack item);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the item the player is currently holding
|
||||
+ * Gets the item the player is currently holding
|
||||
* in their off hand.
|
||||
*
|
||||
* @return the currently held item
|
||||
@@ -190,7 +190,7 @@ public interface PlayerInventory extends Inventory {
|
||||
void setItemInOffHand(@Nullable ItemStack item);
|
||||
|
||||
/**
|
||||
- * Gets a copy of the item the player is currently holding
|
||||
+ * Gets the item the player is currently holding
|
||||
*
|
||||
* @return the currently held item
|
||||
* @see #getItemInMainHand()
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue