From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 From: Zach Brown Date: Sat, 10 Jun 2017 16:59:40 -0500 Subject: [PATCH] Fix upstream javadocs diff --git a/src/main/java/org/bukkit/BanList.java b/src/main/java/org/bukkit/BanList.java index a04cde615f8c4bc593f8d9f8f6f1438008aaa707..548f6d28c28d74bed8b58ee82875909354afe132 100644 --- a/src/main/java/org/bukkit/BanList.java +++ b/src/main/java/org/bukkit/BanList.java @@ -38,6 +38,9 @@ public interface BanList { /** * Gets a {@link BanEntry} by target. + *

+ * Bans by name for ban type {@link Type#NAME NAME} are no longer supported and this method will return + * null when trying to request them. The replacement is bans by UUID. * * @param target entry parameter to search for * @return the corresponding entry, or null if none found @@ -59,6 +62,9 @@ public interface BanList { /** * Adds a ban to this list. If a previous ban exists, this will * update the previous entry. + *

+ * Bans by name for ban type {@link Type#NAME NAME} are no longer supported and this method will return + * null when trying to request them. The replacement is bans by UUID. * * @param target the target of the ban * @param reason reason for the ban, null indicates implementation default @@ -139,6 +145,9 @@ public interface BanList { /** * Gets if a {@link BanEntry} exists for the target, indicating an active * ban status. + *

+ * Bans by name for ban type {@link Type#NAME NAME} are no longer supported. + * The replacement is bans by UUID. * * @param target the target to find * @return true if a {@link BanEntry} exists for the target, indicating an @@ -161,6 +170,9 @@ public interface BanList { /** * Removes the specified target from this list, therefore indicating a * "not banned" status. + *

+ * Bans by name for ban type {@link Type#NAME NAME} are no longer supported. + * The replacement is bans by UUID. * * @param target the target to remove from this list */ diff --git a/src/main/java/org/bukkit/Bukkit.java b/src/main/java/org/bukkit/Bukkit.java index ff83383c3fcbf4de3e6be0a0a950f132b6c47807..22d63e82c3c7d54e90c5cd7adef09882f01c7da2 100644 --- a/src/main/java/org/bukkit/Bukkit.java +++ b/src/main/java/org/bukkit/Bukkit.java @@ -1474,6 +1474,8 @@ public final class Bukkit { /** * Gets every player that has ever played on this server. + *

+ * This method can be expensive as it loads all the player data files from the disk. * * @return an array containing all previous players */ diff --git a/src/main/java/org/bukkit/ChunkSnapshot.java b/src/main/java/org/bukkit/ChunkSnapshot.java index 0cf808356a1a5c6fc4bcf97a694ed9beb80a776a..dc765dea47a9a1c1520fb16ddb24f81413ed0dd1 100644 --- a/src/main/java/org/bukkit/ChunkSnapshot.java +++ b/src/main/java/org/bukkit/ChunkSnapshot.java @@ -136,7 +136,7 @@ public interface ChunkSnapshot { * Get raw biome temperature at given coordinates * * @param x X-coordinate (0-15) - * @param y Y-coordinate (0-15) + * @param y Y-coordinate (world minHeight (inclusive) - world maxHeight (exclusive)) * @param z Z-coordinate (0-15) * @return temperature at given coordinate */ diff --git a/src/main/java/org/bukkit/RegionAccessor.java b/src/main/java/org/bukkit/RegionAccessor.java index 4c9fd558fbf7f57a948fbb7f80f4651048c0fb57..458119a9ef7ce8e1f59bd47caa5b4bc698715440 100644 --- a/src/main/java/org/bukkit/RegionAccessor.java +++ b/src/main/java/org/bukkit/RegionAccessor.java @@ -158,7 +158,7 @@ public interface RegionAccessor { * Creates a tree at the given {@link Location} * * @param location Location to spawn the tree - * @param random Random to use to generated the tree + * @param random Random to use to generate the tree * @param type Type of the tree to create * @return true if the tree was created successfully, otherwise false */ @@ -170,14 +170,14 @@ public interface RegionAccessor { * The provided consumer gets called for every block which gets changed * as a result of the tree generation. When the consumer gets called no * modifications to the world are done yet. Which means, that calling - * {@link #getBlockState(Location)} in the consumer while return the state + * {@link #getBlockState(Location)} in the consumer will return the state * of the block before the generation. *

* Modifications done to the {@link BlockState} in the consumer are respected, * which means that it is not necessary to call {@link BlockState#update()} * * @param location Location to spawn the tree - * @param random Random to use to generated the tree + * @param random Random to use to generate the tree * @param type Type of the tree to create * @param stateConsumer The consumer which should get called for every block which gets changed * @return true if the tree was created successfully, otherwise false @@ -197,7 +197,7 @@ public interface RegionAccessor { * If it returns {@code false} the block won't get set in the world. * * @param location Location to spawn the tree - * @param random Random to use to generated the tree + * @param random Random to use to generate the tree * @param type Type of the tree to create * @param statePredicate The predicate which should get used to test if a block should be set or not. * @return true if the tree was created successfully, otherwise false diff --git a/src/main/java/org/bukkit/Server.java b/src/main/java/org/bukkit/Server.java index 1c088886add66f1e99bee42f70e5bc742c912e88..5a8f15195b0a87bb7a49983e5ee0dee6d2ce242c 100644 --- a/src/main/java/org/bukkit/Server.java +++ b/src/main/java/org/bukkit/Server.java @@ -552,13 +552,10 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi * *

* Note: If set to 0, {@link SpawnCategory} mobs spawning will be disabled. - *

- * Minecraft default: 1. - *
- * Note: the {@link SpawnCategory#MISC} are not consider. * * @param spawnCategory the category of spawn * @return the default ticks per {@link SpawnCategory} mobs spawn value + * @throws IllegalArgumentException if the category is {@link SpawnCategory#MISC} */ public int getTicksPerSpawns(@NotNull SpawnCategory spawnCategory); @@ -1258,6 +1255,8 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi /** * Gets every player that has ever played on this server. + *

+ * This method can be expensive as it loads all the player data files from the disk. * * @return an array containing all previous players */ diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java index 61639a865b8b8a845c78dcaf0a866082ef54bf63..f3607ab95f7f725283e8317c426dbc11bcc15cde 100644 --- a/src/main/java/org/bukkit/World.java +++ b/src/main/java/org/bukkit/World.java @@ -2673,7 +2673,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient /** * Find the closest nearby structure of a given {@link StructureType}. * Finding unexplored structures can, and will, block if the world is - * looking in chunks that gave not generated yet. This can lead to the world + * looking in chunks that have not generated yet. This can lead to the world * temporarily freezing while locating an unexplored structure. *

* The {@code radius} is not a rigid square radius. Each structure may alter @@ -2707,7 +2707,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient /** * Find the closest nearby structure of a given {@link StructureType}. * Finding unexplored structures can, and will, block if the world is - * looking in chunks that gave not generated yet. This can lead to the world + * looking in chunks that have not generated yet. This can lead to the world * temporarily freezing while locating an unexplored structure. *

* The {@code radius} is not a rigid square radius. Each structure may alter @@ -2740,7 +2740,7 @@ public interface World extends RegionAccessor, WorldInfo, PluginMessageRecipient /** * Find the closest nearby structure of a given {@link Structure}. Finding * unexplored structures can, and will, block if the world is looking in - * chunks that gave not generated yet. This can lead to the world + * chunks that have not generated yet. This can lead to the world * temporarily freezing while locating an unexplored structure. *

* The {@code radius} is not a rigid square radius. Each structure may alter diff --git a/src/main/java/org/bukkit/block/Bed.java b/src/main/java/org/bukkit/block/Bed.java index f9bd74f9ce6bd6650726e5a993f9b6e292cdc74d..f4c37ce1fe7aac3dde8485ee51fc8888ed56e79e 100644 --- a/src/main/java/org/bukkit/block/Bed.java +++ b/src/main/java/org/bukkit/block/Bed.java @@ -4,7 +4,22 @@ import org.bukkit.material.Colorable; /** * Represents a captured state of a bed. - * @deprecated does not provide useful information beyond the material itself */ -@Deprecated -public interface Bed extends TileState, Colorable { } +// Paper start +// @Deprecated +public interface Bed extends TileState, Colorable { + + @Override + @org.jetbrains.annotations.NotNull org.bukkit.DyeColor getColor(); + + /** + * Unsupported + * + * @throws UnsupportedOperationException not supported, set the block type + */ + @Override + @org.jetbrains.annotations.Contract("_ -> fail") + @Deprecated(forRemoval = true) + void setColor(@org.bukkit.UndefinedNullability("not supported") org.bukkit.DyeColor color); +// Paper end +} diff --git a/src/main/java/org/bukkit/block/Block.java b/src/main/java/org/bukkit/block/Block.java index f8e12868f2e629cdf4784f0157fdb2f8e7b01f99..870ad6cd930653e6248abcc0fce94ffafbe9ebde 100644 --- a/src/main/java/org/bukkit/block/Block.java +++ b/src/main/java/org/bukkit/block/Block.java @@ -357,7 +357,7 @@ public interface Block extends Metadatable, Translatable { * Gets the temperature of this block. *

* If the raw biome temperature without adjusting for height effects is - * required then please use {@link World#getTemperature(int, int)}. + * required then please use {@link World#getTemperature(int, int, int)}. * * @return Temperature of this block */ diff --git a/src/main/java/org/bukkit/block/data/BlockData.java b/src/main/java/org/bukkit/block/data/BlockData.java index dff615d7cc190e11b31cd76167327d2eb4580593..b70176b9ca3c3fb7d68aa7bc92b7ca6329255bd7 100644 --- a/src/main/java/org/bukkit/block/data/BlockData.java +++ b/src/main/java/org/bukkit/block/data/BlockData.java @@ -224,7 +224,7 @@ public interface BlockData extends Cloneable { * {@link Material#REDSTONE_WIRE} -> {@link Material#REDSTONE} * {@link Material#CARROTS} -> {@link Material#CARROT} * - * @return placement material + * @return placement material or {@link Material#AIR} if it doesn't have one */ @NotNull Material getPlacementMaterial(); diff --git a/src/main/java/org/bukkit/block/data/FaceAttachable.java b/src/main/java/org/bukkit/block/data/FaceAttachable.java index 9599e1237b9717ddbf84c3738bf6c1293e8b3c54..950266b4bb0a2fabeb9539c5676ed58f0b0fe620 100644 --- a/src/main/java/org/bukkit/block/data/FaceAttachable.java +++ b/src/main/java/org/bukkit/block/data/FaceAttachable.java @@ -38,7 +38,7 @@ public interface FaceAttachable extends BlockData { */ WALL, /** - * The switch is mounted to the ceiling and pointing dowanrds. + * The switch is mounted to the ceiling and pointing downwards. */ CEILING; } diff --git a/src/main/java/org/bukkit/block/data/type/CommandBlock.java b/src/main/java/org/bukkit/block/data/type/CommandBlock.java index 9a7122c907308e4e0a4d0eab815df16899503c19..3b1dab4c1c38477fbe651382f37fdb042ce67cd1 100644 --- a/src/main/java/org/bukkit/block/data/type/CommandBlock.java +++ b/src/main/java/org/bukkit/block/data/type/CommandBlock.java @@ -4,7 +4,7 @@ import org.bukkit.block.data.Directional; /** * 'conditional' denotes whether this command block is conditional or not, i.e. - * will only execute if the preceeding command block also executed successfully. + * will only execute if the preceding command block also executed successfully. */ public interface CommandBlock extends Directional { diff --git a/src/main/java/org/bukkit/block/data/type/Gate.java b/src/main/java/org/bukkit/block/data/type/Gate.java index 494f97d47b52bc99b13748c1b57730fbd37d8f51..ebc98607b93294847f95e793304bc5d2528de2a3 100644 --- a/src/main/java/org/bukkit/block/data/type/Gate.java +++ b/src/main/java/org/bukkit/block/data/type/Gate.java @@ -5,7 +5,7 @@ import org.bukkit.block.data.Openable; import org.bukkit.block.data.Powerable; /** - * 'in_wall" indicates if the fence gate is attached to a wall, and if true the + * 'in_wall' indicates if the fence gate is attached to a wall, and if true the * texture is lowered by a small amount to blend in better. */ public interface Gate extends Directional, Openable, Powerable { diff --git a/src/main/java/org/bukkit/block/data/type/Switch.java b/src/main/java/org/bukkit/block/data/type/Switch.java index be06f8db02ca41d5cc3a5dc02951ad27e3cc8f9d..d91a07c7bcb36b3810bb2db89afef1eefd89253d 100644 --- a/src/main/java/org/bukkit/block/data/type/Switch.java +++ b/src/main/java/org/bukkit/block/data/type/Switch.java @@ -21,7 +21,7 @@ public interface Switch extends Directional, FaceAttachable, Powerable { * Sets the value of the 'face' property. * * @param face the new 'face' value - * @deprecated use {@link #getAttachedFace()} + * @deprecated use {@link #setAttachedFace(AttachedFace)} */ @Deprecated void setFace(@NotNull Face face); @@ -42,7 +42,7 @@ public interface Switch extends Directional, FaceAttachable, Powerable { */ WALL, /** - * The switch is mounted to the ceiling and pointing dowanrds. + * The switch is mounted to the ceiling and pointing downwards. */ CEILING; } diff --git a/src/main/java/org/bukkit/entity/ArmorStand.java b/src/main/java/org/bukkit/entity/ArmorStand.java index 91fc11dda99de506be83d40df8929bf7cd8e8d85..7dc631ebd009f5f5c3ac1699c3f3515c47609c05 100644 --- a/src/main/java/org/bukkit/entity/ArmorStand.java +++ b/src/main/java/org/bukkit/entity/ArmorStand.java @@ -360,5 +360,8 @@ public interface ArmorStand extends LivingEntity { * @param move {@code true} if this armour stand can move, {@code false} otherwise */ void setCanMove(boolean move); + + @Override + org.bukkit.inventory.@NotNull EntityEquipment getEquipment(); // Paper end } diff --git a/src/main/java/org/bukkit/entity/Arrow.java b/src/main/java/org/bukkit/entity/Arrow.java index 8eb0cf31b1ce6d714a14cf65bbb117ff163ae2f3..8e57082e8b19a2fd9625816c2ea4a90d41f78ca5 100644 --- a/src/main/java/org/bukkit/entity/Arrow.java +++ b/src/main/java/org/bukkit/entity/Arrow.java @@ -93,7 +93,7 @@ public interface Arrow extends AbstractArrow { * Removes a custom potion effect from this arrow. * * @param type the potion effect type to remove - * @return true if the an effect was removed as a result of this call + * @return true if the effect was removed as a result of this call * @throws IllegalArgumentException if this operation would leave the Arrow * in a state with no Custom Effects and PotionType.UNCRAFTABLE */ diff --git a/src/main/java/org/bukkit/entity/EnderDragon.java b/src/main/java/org/bukkit/entity/EnderDragon.java index 1e56aef9188487d3e9c737e85025f601ab359a72..92cd35c87bad578c2b714761c93a5b72ebf4bc9e 100644 --- a/src/main/java/org/bukkit/entity/EnderDragon.java +++ b/src/main/java/org/bukkit/entity/EnderDragon.java @@ -30,7 +30,7 @@ public interface EnderDragon extends ComplexLivingEntity, Boss, Mob, Enemy { */ FLY_TO_PORTAL, /** - * The dragon will land on on the portal. If the dragon is not near + * The dragon will land on the portal. If the dragon is not near * the portal, it will fly to it before mounting. */ LAND_ON_PORTAL, diff --git a/src/main/java/org/bukkit/entity/HumanEntity.java b/src/main/java/org/bukkit/entity/HumanEntity.java index 09936f3a2376a46721bbc8365c989581c2a789ef..3845a726adbd0e75d7bf2aeeb6da8cb571d51a8f 100644 --- a/src/main/java/org/bukkit/entity/HumanEntity.java +++ b/src/main/java/org/bukkit/entity/HumanEntity.java @@ -22,6 +22,11 @@ import org.jetbrains.annotations.Nullable; */ public interface HumanEntity extends LivingEntity, AnimalTamer, InventoryHolder { + // Paper start + @Override + org.bukkit.inventory.@NotNull EntityEquipment getEquipment(); + // Paper end + /** * Returns the name of this player * diff --git a/src/main/java/org/bukkit/entity/ItemFrame.java b/src/main/java/org/bukkit/entity/ItemFrame.java index b688b3856cb3068a539fcecfbfa113f8ab4160a9..c275b881cbd11307a6dcc7190d7a7d4063000ad8 100644 --- a/src/main/java/org/bukkit/entity/ItemFrame.java +++ b/src/main/java/org/bukkit/entity/ItemFrame.java @@ -75,7 +75,7 @@ public interface ItemFrame extends Hanging { public void setRotation(@NotNull Rotation rotation) throws IllegalArgumentException; /** - * Returns whether the item frame is be visible or not. + * Returns whether the item frame is visible or not. * * @return whether the item frame is visible or not */ diff --git a/src/main/java/org/bukkit/entity/Mob.java b/src/main/java/org/bukkit/entity/Mob.java index 2926fa6071bc7640cc10280b5c3962b0ce7686f1..4f63988848443aff55619bc12ef12c925642a3f9 100644 --- a/src/main/java/org/bukkit/entity/Mob.java +++ b/src/main/java/org/bukkit/entity/Mob.java @@ -9,6 +9,10 @@ import org.jetbrains.annotations.Nullable; */ public interface Mob extends LivingEntity, Lootable { + // Paper start + @Override + org.bukkit.inventory.@org.jetbrains.annotations.NotNull EntityEquipment getEquipment(); + // Paper end /** * Instructs this Mob to set the specified LivingEntity as its target. *

diff --git a/src/main/java/org/bukkit/entity/PigZombie.java b/src/main/java/org/bukkit/entity/PigZombie.java index ae9eaaa8e38e1d9dfc459926c7fc51ddb89de84a..b2ec535bb1b0ce0c114ddd7638b90218b05cd835 100644 --- a/src/main/java/org/bukkit/entity/PigZombie.java +++ b/src/main/java/org/bukkit/entity/PigZombie.java @@ -44,8 +44,6 @@ public interface PigZombie extends Zombie { /** * Not applicable to this entity - * - * @return UnsuppotedOperationException */ @Override public int getConversionTime(); diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java index 27d5503638d13ca2998ce4a4c6589ea62066128e..0c5f57e7530430de22a5eeb861032f04b2bc66c4 100644 --- a/src/main/java/org/bukkit/entity/Player.java +++ b/src/main/java/org/bukkit/entity/Player.java @@ -432,15 +432,15 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM /** * Saves the players current location, health, inventory, motion, and - * other information into the username.dat file, in the world/player - * folder + * other information into the <uuid>.dat file, in the + * <level-name>/playerdata/ folder. */ public void saveData(); /** * Loads the players current location, health, inventory, motion, and - * other information from the username.dat file, in the world/player - * folder. + * other information from the <uuid>.dat file, in the + * <level-name>/playerdata/ folder. *

* Note: This will overwrite the players current inventory, health, * motion, etc, with the state from the saved dat file. @@ -736,7 +736,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM /** * Plays an effect to just this player. * - * @param the data based based on the type of the effect + * @param the data based on the type of the effect * @param loc the location to play the effect at * @param effect the {@link Effect} * @param data a data bit needed for some effects @@ -1121,7 +1121,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM * * Use supplied alternative character to the section symbol to represent legacy color codes. * - * @param alternateChar Alternate symbol such as '&' + * @param alternateChar Alternate symbol such as '&' * @param message The message to send * @deprecated use {@link #sendActionBar(net.kyori.adventure.text.Component)} */ @@ -1587,7 +1587,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM /** * Allows this player to see a player that was previously hidden. If - * another another plugin had hidden the player too, then the player will + * another plugin had hidden the player too, then the player will * remain hidden until the other plugin calls this method too. * * @param plugin Plugin that wants to show the player @@ -1616,7 +1616,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM /** * Allows this player to see an entity that was previously hidden. If - * another another plugin had hidden the entity too, then the entity will + * another plugin had hidden the entity too, then the entity will * remain hidden until the other plugin calls this method too. * * @param plugin Plugin that wants to show the entity @@ -1703,9 +1703,6 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM * case this method will have no affect on them. Use the * {@link PlayerResourcePackStatusEvent} to figure out whether or not * the player loaded the pack! - *

  • There is no concept of resetting texture packs back to default - * within Minecraft, so players will have to relog to do so or you - * have to send an empty pack. *
  • The request is send with "null" as the hash. This might result * in newer versions not loading the pack correctly. * @@ -1739,9 +1736,6 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM * case this method will have no affect on them. Use the * {@link PlayerResourcePackStatusEvent} to figure out whether or not * the player loaded the pack! - *
  • There is no concept of resetting resource packs back to default - * within Minecraft, so players will have to relog to do so or you - * have to send an empty pack. *
  • The request is send with empty string as the hash. This might result * in newer versions not loading the pack correctly. * @@ -1778,9 +1772,6 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM * case this method will have no affect on them. Use the * {@link PlayerResourcePackStatusEvent} to figure out whether or not * the player loaded the pack! - *
  • There is no concept of resetting resource packs back to default - * within Minecraft, so players will have to relog to do so or you - * have to send an empty pack. *
  • The request is sent with empty string as the hash when the hash is * not provided. This might result in newer versions not loading the * pack correctly. diff --git a/src/main/java/org/bukkit/entity/Slime.java b/src/main/java/org/bukkit/entity/Slime.java index a5ad3250cebfeb302c58e0bfd6db1295913c927e..bfac874840cf1f36afba16ae4d176c5821a68cfb 100644 --- a/src/main/java/org/bukkit/entity/Slime.java +++ b/src/main/java/org/bukkit/entity/Slime.java @@ -11,6 +11,16 @@ public interface Slime extends Mob, Enemy { public int getSize(); /** + * Setting the size of the slime (regardless of previous size) + * will set the following attributes: + *
      + *
    • {@link org.bukkit.attribute.Attribute#GENERIC_MAX_HEALTH}
      • + *
    • {@link org.bukkit.attribute.Attribute#GENERIC_MOVEMENT_SPEED}
      • + *
    • {@link org.bukkit.attribute.Attribute#GENERIC_ATTACK_DAMAGE}
      • + *
    + * to their per-size defaults and heal the + * slime to its max health (assuming it's alive). + * * @param sz The new size of the slime. */ public void setSize(int sz); diff --git a/src/main/java/org/bukkit/entity/Sniffer.java b/src/main/java/org/bukkit/entity/Sniffer.java index af5110b4160979c39cc1e5de6fa3bd7957b21403..15a0a733b0e5804655b5957cbf20831290d52a08 100644 --- a/src/main/java/org/bukkit/entity/Sniffer.java +++ b/src/main/java/org/bukkit/entity/Sniffer.java @@ -12,8 +12,6 @@ public interface Sniffer extends Animals { /** * Gets the locations explored by the sniffer. - *
    - * Note: the returned locations use sniffer's current world. * * @return a collection of locations */ @@ -22,9 +20,6 @@ public interface Sniffer extends Animals { /** * Remove a location of the explored locations. - *
    - * Note: the location must be in the sniffer's current world for this - * method to have any effect. * * @param location the location to remove * @see #getExploredLocations() diff --git a/src/main/java/org/bukkit/entity/Villager.java b/src/main/java/org/bukkit/entity/Villager.java index 6bf3af3ed81b66f61e53105d3591165ea74dba0e..a91400cd8bb4c72d1f3200a17f6de025540fe09d 100644 --- a/src/main/java/org/bukkit/entity/Villager.java +++ b/src/main/java/org/bukkit/entity/Villager.java @@ -202,7 +202,7 @@ public interface Villager extends AbstractVillager { */ NITWIT, /** - * Sheperd profession. Wears a brown robe. Shepherds primarily trade for + * Shepherd profession. Wears a brown robe. Shepherds primarily trade for * wool items, and shears. */ SHEPHERD, diff --git a/src/main/java/org/bukkit/event/block/BlockExplodeEvent.java b/src/main/java/org/bukkit/event/block/BlockExplodeEvent.java index 44f7f6939a27b9a0a796d91eac4b7c97ec90a643..641c71ab66bd2499b35cf3c1d533fd105d096e10 100644 --- a/src/main/java/org/bukkit/event/block/BlockExplodeEvent.java +++ b/src/main/java/org/bukkit/event/block/BlockExplodeEvent.java @@ -7,7 +7,9 @@ import org.bukkit.event.HandlerList; import org.jetbrains.annotations.NotNull; /** - * Called when a block explodes + * Called when a block explodes interacting with blocks. The + * event isn't called if the {@link org.bukkit.GameRule#MOB_GRIEFING} + * is disabled as no block interaction will occur. */ public class BlockExplodeEvent extends BlockEvent implements Cancellable { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/block/BlockPlaceEvent.java b/src/main/java/org/bukkit/event/block/BlockPlaceEvent.java index be0a2d1f234d8265d98e54e518a994957b1f3ab7..4e3c406ba883aae553e8d69b6b719b872cd6096c 100644 --- a/src/main/java/org/bukkit/event/block/BlockPlaceEvent.java +++ b/src/main/java/org/bukkit/event/block/BlockPlaceEvent.java @@ -114,7 +114,7 @@ public class BlockPlaceEvent extends BlockEvent implements Cancellable { /** * Gets the value whether the player would be allowed to build here. - * Defaults to spawn if the server was going to stop them (such as, the + * Defaults to false if the server was going to stop them (such as, the * player is in Spawn). Note that this is an entirely different check * than BLOCK_CANBUILD, as this refers to a player, not universe-physics * rule like cactus on dirt. diff --git a/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java b/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java index 2ff1b1308571d8f8056d3359e8a8ba4a589c3726..e9a6e5be5f33a342f7e5c496f0f1c64b2f302ace 100644 --- a/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java +++ b/src/main/java/org/bukkit/event/enchantment/PrepareItemEnchantEvent.java @@ -80,7 +80,7 @@ public class PrepareItemEnchantEvent extends InventoryEvent implements Cancellab /** * Get a list of available {@link EnchantmentOffer} for the player. You can * modify the values to change the available offers for the player. An offer - * may be null, if there isn't a enchantment offer at a specific slot. There + * may be null, if there isn't an enchantment offer at a specific slot. There * are 3 slots in the enchantment table available to modify. * * @return list of available enchantment offers diff --git a/src/main/java/org/bukkit/event/entity/AreaEffectCloudApplyEvent.java b/src/main/java/org/bukkit/event/entity/AreaEffectCloudApplyEvent.java index a37febd0d4dd5b733e9ee72628fdf9395fec4367..9cee218b9ee14688356f16b1f58512186286e7e9 100644 --- a/src/main/java/org/bukkit/event/entity/AreaEffectCloudApplyEvent.java +++ b/src/main/java/org/bukkit/event/entity/AreaEffectCloudApplyEvent.java @@ -8,7 +8,7 @@ import org.bukkit.event.HandlerList; import org.jetbrains.annotations.NotNull; /** - * Called when a lingering potion applies it's effects. Happens + * Called when a lingering potion applies its effects. Happens * once every 5 ticks */ public class AreaEffectCloudApplyEvent extends EntityEvent implements Cancellable { diff --git a/src/main/java/org/bukkit/event/entity/CreatureSpawnEvent.java b/src/main/java/org/bukkit/event/entity/CreatureSpawnEvent.java index e9de00e9e434d36117a672fa9fbfc7c52f284b67..4065432c884324b107d04f4ccd486085b0c440e7 100644 --- a/src/main/java/org/bukkit/event/entity/CreatureSpawnEvent.java +++ b/src/main/java/org/bukkit/event/entity/CreatureSpawnEvent.java @@ -154,11 +154,12 @@ public class CreatureSpawnEvent extends EntitySpawnEvent { */ DROWNED, /** - * When an cow is spawned by shearing a mushroom cow + * When a cow is spawned by shearing a mushroom cow */ SHEARED, /** - * When eg an effect cloud is spawned as a result of a creeper exploding + * When an entity is spawned as a result of an explosion. Like an area effect cloud from + * a creeper or a dragon fireball. */ EXPLOSION, /** diff --git a/src/main/java/org/bukkit/event/entity/EntityExplodeEvent.java b/src/main/java/org/bukkit/event/entity/EntityExplodeEvent.java index 10d0e18dfd423b108fe381e8142867eb10399359..099efafa14c10910e4ed04abb1823f0c1a96b6a6 100644 --- a/src/main/java/org/bukkit/event/entity/EntityExplodeEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityExplodeEvent.java @@ -9,7 +9,9 @@ import org.bukkit.event.HandlerList; import org.jetbrains.annotations.NotNull; /** - * Called when an entity explodes + * Called when an entity explodes interacting with blocks. The + * event isn't called if the {@link org.bukkit.GameRule#MOB_GRIEFING} + * is disabled as no block interaction will occur. */ public class EntityExplodeEvent extends EntityEvent implements Cancellable { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/entity/EntityPickupItemEvent.java b/src/main/java/org/bukkit/event/entity/EntityPickupItemEvent.java index c866df03d66dd8724e12c7353da4cf144c70b2c8..94ee5a3354722aa5d825da727b7b7071fdc6bacc 100644 --- a/src/main/java/org/bukkit/event/entity/EntityPickupItemEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityPickupItemEvent.java @@ -7,7 +7,7 @@ import org.bukkit.event.HandlerList; import org.jetbrains.annotations.NotNull; /** - * Thrown when a entity picks an item up from the ground + * Thrown when an entity picks an item up from the ground */ public class EntityPickupItemEvent extends EntityEvent implements Cancellable { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/entity/EntityPlaceEvent.java b/src/main/java/org/bukkit/event/entity/EntityPlaceEvent.java index 327876e0ad7dcfeb71d9d22afe1c04bcd71c3bf9..71d664dd89995f088c47d17b38547d530319470c 100644 --- a/src/main/java/org/bukkit/event/entity/EntityPlaceEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityPlaceEvent.java @@ -11,7 +11,7 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; /** - * Triggered when a entity is created in the world by a player "placing" an item + * Triggered when an entity is created in the world by a player "placing" an item * on a block. *
    * Note that this event is currently only fired for four specific placements: diff --git a/src/main/java/org/bukkit/event/entity/EntityPotionEffectEvent.java b/src/main/java/org/bukkit/event/entity/EntityPotionEffectEvent.java index 01c5e8b71338fbb4b1605e45bf2a2e705188f6b5..c9f395064656dd0126410eb3c6e197baa450c063 100644 --- a/src/main/java/org/bukkit/event/entity/EntityPotionEffectEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityPotionEffectEvent.java @@ -133,7 +133,7 @@ public class EntityPotionEffectEvent extends EntityEvent implements Cancellable public enum Action { /** - * When the potion effect is added because the entity didn't have it's + * When the potion effect is added because the entity didn't have its * type. */ ADDED, @@ -238,7 +238,7 @@ public class EntityPotionEffectEvent extends EntityEvent implements Cancellable */ SPIDER_SPAWN, /** - * When the entity gets effects from a totem item saving it's life. + * When the entity gets effects from a totem item saving its life. */ TOTEM, /** diff --git a/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java b/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java index d51d2ec1d04d9ea8a25a70d0d856f2355ebfcb4a..7ecff9fcee19fc94be784474fea620e5dd434731 100644 --- a/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityRegainHealthEvent.java @@ -105,7 +105,7 @@ public class EntityRegainHealthEvent extends EntityEvent implements Cancellable */ SATIATED, /** - * When a player regains health from eating consumables + * When an animal regains health from eating consumables */ EATING, /** diff --git a/src/main/java/org/bukkit/event/entity/EntityTargetEvent.java b/src/main/java/org/bukkit/event/entity/EntityTargetEvent.java index dee186e99463a56394bbc2039d1e763d109125b9..c6e4d69eecd2789b1d78fe99fe590932e9758ba1 100644 --- a/src/main/java/org/bukkit/event/entity/EntityTargetEvent.java +++ b/src/main/java/org/bukkit/event/entity/EntityTargetEvent.java @@ -156,7 +156,7 @@ public class EntityTargetEvent extends EntityEvent implements Cancellable { FOLLOW_LEADER, /** * When another entity tempts this entity by having a desired item such - * as wheat in it's hand. + * as wheat in its hand. */ TEMPT, /** diff --git a/src/main/java/org/bukkit/event/entity/PiglinBarterEvent.java b/src/main/java/org/bukkit/event/entity/PiglinBarterEvent.java index c17ff41a688b2cbd877cda25d4ec033ac8ef5524..bd67b7cba78b9bbdd82a5a40048e658a979e3108 100644 --- a/src/main/java/org/bukkit/event/entity/PiglinBarterEvent.java +++ b/src/main/java/org/bukkit/event/entity/PiglinBarterEvent.java @@ -10,8 +10,7 @@ import org.jetbrains.annotations.NotNull; /** * Stores all data related to the bartering interaction with a piglin. * - * This event can be triggered by a piglin picking up an item that's on its - * bartering list. + * Called when a piglin completes a barter. */ public class PiglinBarterEvent extends EntityEvent implements Cancellable { diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java index bc71bc2d3ace0d19d730c09f05f9e0655bcee8f5..24077da8e6a7937f66eafc6779206055cf82e8d2 100644 --- a/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java +++ b/src/main/java/org/bukkit/event/inventory/FurnaceBurnEvent.java @@ -8,7 +8,9 @@ import org.bukkit.inventory.ItemStack; import org.jetbrains.annotations.NotNull; /** - * Called when an ItemStack is successfully burned as fuel in a furnace. + * Called when an ItemStack is successfully burned as fuel in a furnace-like block such as a + * {@link org.bukkit.block.Furnace}, {@link org.bukkit.block.Smoker}, or + * {@link org.bukkit.block.BlastFurnace}. */ public class FurnaceBurnEvent extends BlockEvent implements Cancellable { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java index 020739697a0b535cad0b15b574f77cdabbdfa3eb..a965b6a78073c5da86ad671752eff4a270029420 100644 --- a/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java +++ b/src/main/java/org/bukkit/event/inventory/FurnaceExtractEvent.java @@ -7,7 +7,9 @@ import org.bukkit.event.block.BlockExpEvent; import org.jetbrains.annotations.NotNull; /** - * This event is called when a player takes items out of the furnace + * This event is called when a player takes items out of a furnace-like block such as a + * {@link org.bukkit.block.Furnace}, {@link org.bukkit.block.Smoker}, or + * {@link org.bukkit.block.BlastFurnace}. */ public class FurnaceExtractEvent extends BlockExpEvent { private final Player player; diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java index 066e7dd9a34d35c8b643a5efcf95d6a5ef47c7ee..f8f9b08a0bd82a2667ae4e0c99dae9103f0db3f0 100644 --- a/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java +++ b/src/main/java/org/bukkit/event/inventory/FurnaceSmeltEvent.java @@ -6,7 +6,9 @@ import org.bukkit.inventory.ItemStack; import org.jetbrains.annotations.NotNull; /** - * Called when an ItemStack is successfully smelted in a furnace. + * Called when an ItemStack is successfully smelted in a furnace-like block + * such as a {@link org.bukkit.block.Furnace}, {@link org.bukkit.block.Smoker}, + * or {@link org.bukkit.block.BlastFurnace}. */ public class FurnaceSmeltEvent extends BlockCookEvent { diff --git a/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java b/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java index 1440c6115520d692faf75455df35b92aa8734491..0808e7aeffb69160913344de5b5e21d5e857f1d6 100644 --- a/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java +++ b/src/main/java/org/bukkit/event/inventory/FurnaceStartSmeltEvent.java @@ -8,7 +8,10 @@ import org.bukkit.inventory.ItemStack; import org.jetbrains.annotations.NotNull; /** - * Called when a Furnace starts smelting. + * Called when any of the furnace-like blocks start smelting. + *

    + * Furnace-like blocks are {@link org.bukkit.block.Furnace}, + * {@link org.bukkit.block.Smoker}, and {@link org.bukkit.block.BlastFurnace}. */ public class FurnaceStartSmeltEvent extends InventoryBlockStartEvent { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java b/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java index 79797a2be7fb139d528116d34d13e51d39b96e56..fe58058f9b5d29388d48115cc81dc48ab08c58c1 100644 --- a/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java +++ b/src/main/java/org/bukkit/event/inventory/InventoryClickEvent.java @@ -19,9 +19,10 @@ import org.jetbrains.annotations.Nullable; * Because InventoryClickEvent occurs within a modification of the Inventory, * not all Inventory related methods are safe to use. *

    - * The following should never be invoked by an EventHandler for - * InventoryClickEvent using the HumanEntity or InventoryView associated with - * this event: + * Methods that change the view a player is looking at should never be invoked + * by an EventHandler for InventoryClickEvent using the HumanEntity or + * InventoryView associated with this event. + * Examples of these include: *

      *
    • {@link HumanEntity#closeInventory()} *
    • {@link HumanEntity#openInventory(Inventory)} @@ -92,7 +93,7 @@ public class InventoryClickEvent extends InventoryInteractEvent { /** * Gets the ItemStack currently in the clicked slot. * - * @return the item in the clicked + * @return the item in the clicked slot */ @Nullable public ItemStack getCurrentItem() { diff --git a/src/main/java/org/bukkit/event/inventory/InventoryCloseEvent.java b/src/main/java/org/bukkit/event/inventory/InventoryCloseEvent.java index 5861247c1b8ee4fe2736fd5098e05a2ca9ab78ea..c0cc82d98348e8aae3cb56bafb2fcb590b03094f 100644 --- a/src/main/java/org/bukkit/event/inventory/InventoryCloseEvent.java +++ b/src/main/java/org/bukkit/event/inventory/InventoryCloseEvent.java @@ -7,7 +7,26 @@ import org.bukkit.inventory.InventoryView; import org.jetbrains.annotations.NotNull; /** - * Represents a player related inventory event + * This event is called when a player closes an inventory. + *

      + * Because InventoryCloseEvent occurs within a modification of the Inventory, + * not all Inventory related methods are safe to use. + *

      + * Methods that change the view a player is looking at should never be invoked + * by an EventHandler for InventoryCloseEvent using the HumanEntity or + * InventoryView associated with this event. + * Examples of these include: + *

        + *
      • {@link HumanEntity#closeInventory()} + *
      • {@link HumanEntity#openInventory(org.bukkit.inventory.Inventory)} + *
      • {@link HumanEntity#openWorkbench(org.bukkit.Location, boolean)} + *
      • {@link HumanEntity#openEnchanting(org.bukkit.Location, boolean)} + *
      • {@link InventoryView#close()} + *
      + * To invoke one of these methods, schedule a task using + * {@link org.bukkit.scheduler.BukkitScheduler#runTask(org.bukkit.plugin.Plugin, Runnable)}, which will run the task + * on the next tick. Also be aware that this is not an exhaustive list, and + * other methods could potentially create issues as well. */ public class InventoryCloseEvent extends InventoryEvent { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/inventory/InventoryOpenEvent.java b/src/main/java/org/bukkit/event/inventory/InventoryOpenEvent.java index 9013d043503d175004ad276799e5935b7fa59dc4..ceae092eb782698803c6c3df41267dde20ba62b2 100644 --- a/src/main/java/org/bukkit/event/inventory/InventoryOpenEvent.java +++ b/src/main/java/org/bukkit/event/inventory/InventoryOpenEvent.java @@ -7,7 +7,7 @@ import org.bukkit.inventory.InventoryView; import org.jetbrains.annotations.NotNull; /** - * Represents a player related inventory event + * Called when a player opens an inventory */ public class InventoryOpenEvent extends InventoryEvent implements Cancellable { private static final HandlerList handlers = new HandlerList(); diff --git a/src/main/java/org/bukkit/event/inventory/PrepareAnvilEvent.java b/src/main/java/org/bukkit/event/inventory/PrepareAnvilEvent.java index 6782024735a885ba0b1b4dba4a576740c1410366..8977f7609431c3c46324a82de84d4a32f4b71c57 100644 --- a/src/main/java/org/bukkit/event/inventory/PrepareAnvilEvent.java +++ b/src/main/java/org/bukkit/event/inventory/PrepareAnvilEvent.java @@ -24,6 +24,20 @@ public class PrepareAnvilEvent extends PrepareInventoryResultEvent { return (AnvilInventory) super.getInventory(); } + /** + * {@inheritDoc} + * + *

      + * Note: by default custom recipes in anvil are disabled + * you should define a repair cost on the anvil inventory + * greater or equals to zero in order to allow that. + * + * @param result result item + */ + public void setResult(@Nullable ItemStack result) { + super.setResult(result); + } + @NotNull @Override public HandlerList getHandlers() { diff --git a/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java b/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java index e4c32b21ab013703a6a1b07a1ad564d914ebe83f..e58fecf0fe54db06e0e944027923a352fd8005d8 100644 --- a/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java +++ b/src/main/java/org/bukkit/event/player/PlayerResourcePackStatusEvent.java @@ -6,8 +6,9 @@ import org.bukkit.event.HandlerList; import org.jetbrains.annotations.NotNull; /** - * Called when a player takes action on a resource pack request sent via - * {@link Player#setResourcePack(java.lang.String)}. + * Called when a player takes action on a resource pack request. + * @see Player#setResourcePack(String, String) + * @see Player#setResourcePack(String, String, boolean) */ public class PlayerResourcePackStatusEvent extends PlayerEvent { diff --git a/src/main/java/org/bukkit/generator/ChunkGenerator.java b/src/main/java/org/bukkit/generator/ChunkGenerator.java index 0cc6e29a5af28e95f87f415d6b2424d4622a6f34..c0b749a5bbf4980d01fed74768bb61909b579cb9 100644 --- a/src/main/java/org/bukkit/generator/ChunkGenerator.java +++ b/src/main/java/org/bukkit/generator/ChunkGenerator.java @@ -627,7 +627,7 @@ public abstract class ChunkGenerator { * Get the biome at x, y, z within chunk being generated * * @param x the x location in the chunk from 0-15 inclusive - * @param y the y location in the chunk from minimum (inclusive) - + * @param y the y location in the chunk from minHeight (inclusive) - * maxHeight (exclusive) * @param z the z location in the chunk from 0-15 inclusive * @return Biome value diff --git a/src/main/java/org/bukkit/inventory/EntityEquipment.java b/src/main/java/org/bukkit/inventory/EntityEquipment.java index d5b50a4a954fed35d37f03f1a277cc173ca106df..16bca8e40ff029cca94bbfd435db1cf22b50ab7e 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. * + *

      + * 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 + * 

      {@code
+     * EntityEquipment equipment = entity.getEquipment();
+     * if (equipment instanceof PlayerInventory) {
+     *     equipment.getItemInMainHand(); // will return a mirror
+     * } else {
+     *     equipment.getItemInMainHand(); // will return a copy
+     * }
+     * }
      + * * @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. * + *

      + * 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 + * 

      {@code
+     * EntityEquipment equipment = entity.getEquipment();
+     * if (equipment instanceof PlayerInventory) {
+     *     equipment.getItemInOffHand(); // will return a mirror
+     * } else {
+     *     equipment.getItemInOffHand(); // will return a copy
+     * }
+     * }
      + * * @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 + * + *

      + * 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 + * 

      {@code
+     * EntityEquipment equipment = entity.getEquipment();
+     * if (equipment instanceof PlayerInventory) {
+     *     equipment.getItemInHand(); // will return a mirror
+     * } else {
+     *     equipment.getItemInHand(); // will return a copy
+     * }
+     * }
      * * @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 + * + *

      + * 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 + * 

      {@code
+     * EntityEquipment equipment = entity.getEquipment();
+     * if (equipment instanceof PlayerInventory) {
+     *     equipment.getHelmet(); // will return a mirror
+     * } else {
+     *     equipment.getHelmet(); // will return a copy
+     * }
+     * }
      * * @return The helmet being worn */ - @Nullable + @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 + * + *

      + * 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 + * 

      {@code
+     * EntityEquipment equipment = entity.getEquipment();
+     * if (equipment instanceof PlayerInventory) {
+     *     equipment.getChestplate(); // will return a mirror
+     * } else {
+     *     equipment.getChestplate(); // will return a copy
+     * }
+     * }
      * * @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 + * + *

      + * 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 + * 

      {@code
+     * EntityEquipment equipment = entity.getEquipment();
+     * if (equipment instanceof PlayerInventory) {
+     *     equipment.getLeggings(); // will return a mirror
+     * } else {
+     *     equipment.getLeggings(); // will return a copy
+     * }
+     * }
      * * @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 + * + *

      + * 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 + * 

      {@code
+     * EntityEquipment equipment = entity.getEquipment();
+     * if (equipment instanceof PlayerInventory) {
+     *     equipment.getBoots(); // will return a mirror
+     * } else {
+     *     equipment.getBoots(); // will return a copy
+     * }
+     * }
      * * @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 + * + *

      + * 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 + * 

      {@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
+     * }
+     * }
      * * @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 @@ -247,7 +354,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop killed by anything *
      * * @return chance of the currently held item being dropped (1 for non-{@link Mob}) @@ -260,7 +368,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @param chance the chance of the main hand item being dropped @@ -274,7 +383,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @return chance of the off hand item being dropped (1 for non-{@link Mob}) @@ -287,7 +397,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @param chance the chance of off hand item being dropped @@ -300,7 +411,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @return the chance of the helmet being dropped (1 for non-{@link Mob}) @@ -312,7 +424,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @param chance of the helmet being dropped @@ -326,7 +439,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @return the chance of the chest plate being dropped (1 for non-{@link Mob}) @@ -339,7 +453,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @param chance of the chest plate being dropped @@ -353,7 +468,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @return the chance of the leggings being dropped (1 for non-{@link Mob}) @@ -366,7 +482,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @param chance chance of the leggings being dropped @@ -379,7 +496,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @return the chance of the boots being dropped (1 for non-{@link Mob}) @@ -391,7 +509,8 @@ public interface EntityEquipment { * *
        *
      • A drop chance of 0.0F will never drop - *
      • A drop chance of 1.0F will always drop + *
      • A drop chance of exactly 1.0F will always drop if killed by a player + *
      • A drop chance of greater than 1.0F will always drop if killed by anything *
      * * @param chance of the boots being dropped diff --git a/src/main/java/org/bukkit/inventory/ItemFlag.java b/src/main/java/org/bukkit/inventory/ItemFlag.java index 42fcc31147934fd4ed6484b0729e938e7ae2f8e2..4e637420b9a39b822be19367a16da93f236549b3 100644 --- a/src/main/java/org/bukkit/inventory/ItemFlag.java +++ b/src/main/java/org/bukkit/inventory/ItemFlag.java @@ -35,7 +35,7 @@ public enum ItemFlag { */ HIDE_DYE, /** - * Setting to show/hide armor trim from leather armor. + * Setting to show/hide armor trim from armor. */ HIDE_ARMOR_TRIM; } 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() diff --git a/src/main/java/org/bukkit/inventory/ShapedRecipe.java b/src/main/java/org/bukkit/inventory/ShapedRecipe.java index 05f1acaac3a49c42f6cf544adb3ffec267c72700..9f9c67e935940833bbfe58e6bfa398e6c86980d5 100644 --- a/src/main/java/org/bukkit/inventory/ShapedRecipe.java +++ b/src/main/java/org/bukkit/inventory/ShapedRecipe.java @@ -24,8 +24,6 @@ public class ShapedRecipe extends CraftingRecipe { * @param result The item you want the recipe to create. * @see ShapedRecipe#shape(String...) * @see ShapedRecipe#setIngredient(char, Material) - * @see ShapedRecipe#setIngredient(char, Material, int) - * @see ShapedRecipe#setIngredient(char, MaterialData) * @see ShapedRecipe#setIngredient(char, RecipeChoice) * @deprecated Recipes must have keys. Use {@link #ShapedRecipe(NamespacedKey, ItemStack)} * instead. @@ -44,8 +42,6 @@ public class ShapedRecipe extends CraftingRecipe { * @param result The item you want the recipe to create. * @see ShapedRecipe#shape(String...) * @see ShapedRecipe#setIngredient(char, Material) - * @see ShapedRecipe#setIngredient(char, Material, int) - * @see ShapedRecipe#setIngredient(char, MaterialData) * @see ShapedRecipe#setIngredient(char, RecipeChoice) */ public ShapedRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result) { diff --git a/src/main/java/org/bukkit/inventory/ShapelessRecipe.java b/src/main/java/org/bukkit/inventory/ShapelessRecipe.java index 3d50775da447175b2a94ed9056ef36aa1e69c2eb..03839302c94adc3175d0a88065cd230257ffd20d 100644 --- a/src/main/java/org/bukkit/inventory/ShapelessRecipe.java +++ b/src/main/java/org/bukkit/inventory/ShapelessRecipe.java @@ -30,11 +30,8 @@ public class ShapelessRecipe extends CraftingRecipe { * @param key the unique recipe key * @param result The item you want the recipe to create. * @see ShapelessRecipe#addIngredient(Material) - * @see ShapelessRecipe#addIngredient(MaterialData) - * @see ShapelessRecipe#addIngredient(Material,int) * @see ShapelessRecipe#addIngredient(int,Material) - * @see ShapelessRecipe#addIngredient(int,MaterialData) - * @see ShapelessRecipe#addIngredient(int,Material,int) + * @see ShapelessRecipe#addIngredient(RecipeChoice) */ public ShapelessRecipe(@NotNull NamespacedKey key, @NotNull ItemStack result) { super(key, result); @@ -174,7 +171,7 @@ public class ShapelessRecipe extends CraftingRecipe { /** * Removes multiple instances of an ingredient from the list. If there are - * less instances then specified, all will be removed. Only removes exact + * fewer instances than specified, all will be removed. Only removes exact * matches, with a data value of 0. * * @param count The number of copies to remove. diff --git a/src/main/java/org/bukkit/inventory/StonecuttingRecipe.java b/src/main/java/org/bukkit/inventory/StonecuttingRecipe.java index 07c3dff4d6190ef388d9c1e1c36f67f00a3e8e66..597a18a767b68b47e81454b7d44613c7178c1366 100644 --- a/src/main/java/org/bukkit/inventory/StonecuttingRecipe.java +++ b/src/main/java/org/bukkit/inventory/StonecuttingRecipe.java @@ -28,7 +28,7 @@ public class StonecuttingRecipe implements Recipe, Keyed { } /** - * Create a cooking recipe to craft the specified ItemStack. + * Create a Stonecutting recipe to craft the specified ItemStack. * * @param key The unique recipe key * @param result The item you want the recipe to create. @@ -42,7 +42,7 @@ public class StonecuttingRecipe implements Recipe, Keyed { } /** - * Sets the input of this cooking recipe. + * Sets the input of this Stonecutting recipe. * * @param input The input material. * @return The changed recipe, so you can chain calls. @@ -64,7 +64,7 @@ public class StonecuttingRecipe implements Recipe, Keyed { } /** - * Sets the input of this cooking recipe. + * Sets the input of this Stonecutting recipe. * * @param input The input choice. * @return The changed recipe, so you can chain calls. diff --git a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java index d7fab2b856f6dfec4f9225c1bdb4254b238d98a4..9d40e6a5ce7adc377934cfc5ce663b5d9cb2e4dc 100644 --- a/src/main/java/org/bukkit/inventory/meta/ItemMeta.java +++ b/src/main/java/org/bukkit/inventory/meta/ItemMeta.java @@ -306,7 +306,7 @@ public interface ItemMeta extends Cloneable, ConfigurationSerializable, Persiste /** * Return an immutable copy of all {@link Attribute}s and their * {@link AttributeModifier}s for a given {@link EquipmentSlot}.
      - * Any {@link AttributeModifier} that does have have a given + * Any {@link AttributeModifier} that does have a given * {@link EquipmentSlot} will be returned. This is because * AttributeModifiers without a slot are active in any slot.
      * If there are no attributes set for the given slot, an empty map diff --git a/src/main/java/org/bukkit/scoreboard/Objective.java b/src/main/java/org/bukkit/scoreboard/Objective.java index 22b1dc5fd4d453161a5ee520072f8e8f955b3a80..a625bcab8e77b05b3341a52c708fae1542b7e3d5 100644 --- a/src/main/java/org/bukkit/scoreboard/Objective.java +++ b/src/main/java/org/bukkit/scoreboard/Objective.java @@ -86,7 +86,7 @@ public interface Objective { * * @return true if scores are modifiable * @throws IllegalStateException if this objective has been unregistered - * @see Criterias#HEALTH + * @see Criteria#HEALTH */ boolean isModifiable(); diff --git a/src/main/java/org/bukkit/scoreboard/Team.java b/src/main/java/org/bukkit/scoreboard/Team.java index 52e8be769d2e9b69e9833bc9a7fe39afd10c5095..4d2b8e10263802432dfeac72666487f9547cd2c5 100644 --- a/src/main/java/org/bukkit/scoreboard/Team.java +++ b/src/main/java/org/bukkit/scoreboard/Team.java @@ -265,7 +265,7 @@ public interface Team extends net.kyori.adventure.audience.ForwardingAudience { * Gets the Set of entries on the team * * @return entries on the team - * @throws IllegalStateException if this entries has been unregistered + * @throws IllegalStateException if this team has been unregistered */ @NotNull Set getEntries(); diff --git a/src/main/java/org/bukkit/util/BoundingBox.java b/src/main/java/org/bukkit/util/BoundingBox.java index 9883983c33fcff0f4c1e23867adafa436e2ed96f..5017b73bcec0d4d5256d89db14201c03829dc981 100644 --- a/src/main/java/org/bukkit/util/BoundingBox.java +++ b/src/main/java/org/bukkit/util/BoundingBox.java @@ -358,7 +358,7 @@ public class BoundingBox implements Cloneable, ConfigurationSerializable { *

      * Negative values will shrink the bounding box in the corresponding * direction. Shrinking will be limited to the point where the affected - * opposite faces would meet if the they shrank at uniform speeds. + * opposite faces would meet if they shrank at uniform speeds. * * @param negativeX the amount of expansion in the negative x direction * @param negativeY the amount of expansion in the negative y direction diff --git a/src/main/java/org/bukkit/util/CachedServerIcon.java b/src/main/java/org/bukkit/util/CachedServerIcon.java index 612958a331575d1da2715531ebdf6b1168f2e860..9a7768d41270714d4a1c89b4dcb436cc66f57545 100644 --- a/src/main/java/org/bukkit/util/CachedServerIcon.java +++ b/src/main/java/org/bukkit/util/CachedServerIcon.java @@ -5,7 +5,7 @@ import org.bukkit.event.server.ServerListPingEvent; import org.jetbrains.annotations.Nullable; /** - * This is a cached version of a server-icon. It's internal representation + * This is a cached version of a server-icon. Its internal representation * and implementation is undefined. * * @see Server#getServerIcon()