mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-30 16:19:03 +01:00
d2ff9c662c
Upstream has released updates that appears to apply and compile correctly. This update has not been tested by PaperMC and as with ANY update, please do your own testing Bukkit Changes: 9d0221aa API to get client side view distance. 9be7f0ea SPIGOT-4395: Additions to PlayerBedEnterEvent. 01e534c6 Minor cosmetic cleanups to imports etc CraftBukkit Changes:96c461b3API to get client side view distance.e2785f4eRemove note about development builda8000588SPIGOT-4395: Additions to PlayerBedEnterEvent. Spigot Changes: 117d4f7e Rebuild patches
396 lines
No EOL
18 KiB
Diff
396 lines
No EOL
18 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Zach Brown <1254957+zachbr@users.noreply.github.com>
|
|
Date: Sat, 10 Jun 2017 16:59:40 -0500
|
|
Subject: [PATCH] Fix upstream javadoc warnings and errors
|
|
|
|
Upstream still refuses to use Java 8 with the API so they are likely unaware these are even issues.
|
|
|
|
diff --git a/src/main/java/org/bukkit/NamespacedKey.java b/src/main/java/org/bukkit/NamespacedKey.java
|
|
index 43239f844..fe8d34685 100644
|
|
--- a/src/main/java/org/bukkit/NamespacedKey.java
|
|
+++ b/src/main/java/org/bukkit/NamespacedKey.java
|
|
@@ -0,0 +0,0 @@ public final class NamespacedKey {
|
|
/**
|
|
* Create a key in a specific namespace.
|
|
*
|
|
- * @param namespace
|
|
- * @param key
|
|
+ * @param namespace String representing a grouping of keys
|
|
+ * @param key Name for this specific key
|
|
* @deprecated should never be used by plugins, for internal use only!!
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/World.java b/src/main/java/org/bukkit/World.java
|
|
index 06bcee03b..849ad2cbb 100644
|
|
--- a/src/main/java/org/bukkit/World.java
|
|
+++ b/src/main/java/org/bukkit/World.java
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param force whether to send the particle to players within an extended
|
|
* range and encourage their client to render it regardless of
|
|
* settings
|
|
+ * @param <T> Particle data type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data, boolean force);
|
|
|
|
@@ -0,0 +0,0 @@ public interface World extends PluginMessageRecipient, Metadatable {
|
|
* @param force whether to send the particle to players within an extended
|
|
* range and encourage their client to render it regardless of
|
|
* settings
|
|
+ * @param <T> Particle data type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data, boolean force);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/AbstractHorse.java b/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
index 107574546..6d5410eab 100644
|
|
--- a/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
+++ b/src/main/java/org/bukkit/entity/AbstractHorse.java
|
|
@@ -0,0 +0,0 @@ public interface AbstractHorse extends Animals, Vehicle, InventoryHolder, Tameab
|
|
public Horse.Variant getVariant();
|
|
|
|
/**
|
|
- * @param variant
|
|
+ * @param variant Variant to set
|
|
* @deprecated you are required to spawn a different entity
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/AreaEffectCloud.java b/src/main/java/org/bukkit/entity/AreaEffectCloud.java
|
|
index 9a569d3a3..8c5efd17e 100644
|
|
--- a/src/main/java/org/bukkit/entity/AreaEffectCloud.java
|
|
+++ b/src/main/java/org/bukkit/entity/AreaEffectCloud.java
|
|
@@ -0,0 +0,0 @@ public interface AreaEffectCloud extends Entity {
|
|
* @param particle the new particle type
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> the particle data type // Paper
|
|
*/
|
|
<T> void setParticle(Particle particle, T data);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/Guardian.java b/src/main/java/org/bukkit/entity/Guardian.java
|
|
index 98af0563c..ec6890ae6 100644
|
|
--- a/src/main/java/org/bukkit/entity/Guardian.java
|
|
+++ b/src/main/java/org/bukkit/entity/Guardian.java
|
|
@@ -0,0 +0,0 @@ public interface Guardian extends Monster {
|
|
public boolean isElder();
|
|
|
|
/**
|
|
- * @param shouldBeElder
|
|
+ * @param shouldBeElder Sets whether the Guardian is an Elder
|
|
* @deprecated Must spawn a new {@link ElderGuardian}.
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/Horse.java b/src/main/java/org/bukkit/entity/Horse.java
|
|
index cfce8fa57..8660070bb 100644
|
|
--- a/src/main/java/org/bukkit/entity/Horse.java
|
|
+++ b/src/main/java/org/bukkit/entity/Horse.java
|
|
@@ -0,0 +0,0 @@ public interface Horse extends AbstractHorse {
|
|
public boolean isCarryingChest();
|
|
|
|
/**
|
|
- * @param chest
|
|
+ * @param chest Sets whether the Horse is carrying a chest
|
|
* @deprecated see {@link ChestedHorse}
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/Player.java b/src/main/java/org/bukkit/entity/Player.java
|
|
index 4b0caae51..45690a2fa 100644
|
|
--- a/src/main/java/org/bukkit/entity/Player.java
|
|
+++ b/src/main/java/org/bukkit/entity/Player.java
|
|
@@ -0,0 +0,0 @@ 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
|
|
*/
|
|
public void sendActionBar(char alternateChar, String message);
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* Update the subtitle of titles displayed to the player
|
|
*
|
|
+ * @param subtitle Subtitle to set
|
|
* @deprecated Use {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* Update the subtitle of titles displayed to the player
|
|
*
|
|
+ * @param subtitle Subtitle to set
|
|
* @deprecated Use {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* Show the given title to the player, along with the last subtitle set, using the last set times
|
|
*
|
|
+ * @param title Title to set
|
|
* @deprecated Use {@link #sendTitle(Title)} or {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
/**
|
|
* Show the given title to the player, along with the last subtitle set, using the last set times
|
|
*
|
|
+ * @param title Title to set
|
|
* @deprecated Use {@link #sendTitle(Title)} or {@link #updateTitle(Title)}
|
|
*/
|
|
@Deprecated
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @param count the number of particles
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* @param offsetZ the maximum random offset on the Z axis
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, Location location, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
@@ -0,0 +0,0 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
|
|
* particle used (normally speed)
|
|
* @param data the data to use for the particle or null,
|
|
* the type of this depends on {@link Particle#getDataType()}
|
|
+ * @param <T> Type
|
|
*/
|
|
public <T> void spawnParticle(Particle particle, double x, double y, double z, int count, double offsetX, double offsetY, double offsetZ, double extra, T data);
|
|
|
|
diff --git a/src/main/java/org/bukkit/entity/Skeleton.java b/src/main/java/org/bukkit/entity/Skeleton.java
|
|
index 2a02ab855..e33d00b30 100644
|
|
--- a/src/main/java/org/bukkit/entity/Skeleton.java
|
|
+++ b/src/main/java/org/bukkit/entity/Skeleton.java
|
|
@@ -0,0 +0,0 @@ public interface Skeleton extends Monster {
|
|
public SkeletonType getSkeletonType();
|
|
|
|
/**
|
|
+ * @param type Type to set
|
|
* @deprecated Must spawn a new subtype variant
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/entity/Zombie.java b/src/main/java/org/bukkit/entity/Zombie.java
|
|
index cf53ea22f..629233796 100644
|
|
--- a/src/main/java/org/bukkit/entity/Zombie.java
|
|
+++ b/src/main/java/org/bukkit/entity/Zombie.java
|
|
@@ -0,0 +0,0 @@ public interface Zombie extends Monster {
|
|
public boolean isVillager();
|
|
|
|
/**
|
|
- * @param flag
|
|
+ * @param flag Sets whether the Zombie is a villager
|
|
* @deprecated must spawn {@link ZombieVillager}.
|
|
*/
|
|
@Deprecated
|
|
public void setVillager(boolean flag);
|
|
|
|
/**
|
|
- * @param profession
|
|
+ * @param profession Sets the ZombieVillager's profession
|
|
* @see ZombieVillager#getVillagerProfession()
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
index de4fb37f3..f1de2af6e 100644
|
|
--- a/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
+++ b/src/main/java/org/bukkit/event/player/PlayerLoginEvent.java
|
|
@@ -0,0 +0,0 @@ public class PlayerLoginEvent extends PlayerEvent {
|
|
* @param hostname The hostname that was used to connect to the server
|
|
* @param address The address the player used to connect, provided for
|
|
* timing issues
|
|
+ * @param realAddress The unspoofed, actual address, that the player used to connect
|
|
*/
|
|
public PlayerLoginEvent(final Player player, final String hostname, final InetAddress address, final InetAddress realAddress) { // Spigot
|
|
super(player);
|
|
@@ -0,0 +0,0 @@ public class PlayerLoginEvent extends PlayerEvent {
|
|
* timing issues
|
|
* @param result The result status for this event
|
|
* @param message The message to be displayed if result denies login
|
|
+ * @param realAddress The unspoofed, actual address, that the player used to connect
|
|
*/
|
|
public PlayerLoginEvent(final Player player, String hostname, final InetAddress address, final Result result, final String message, final InetAddress realAddress) { // Spigot
|
|
this(player, hostname, address, realAddress); // Spigot
|
|
diff --git a/src/main/java/org/bukkit/inventory/ItemFactory.java b/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
index 762c43d69..ec2b8b8ed 100644
|
|
--- a/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
+++ b/src/main/java/org/bukkit/inventory/ItemFactory.java
|
|
@@ -0,0 +0,0 @@ public interface ItemFactory {
|
|
* Apply a material change for an item meta. Do not use under any
|
|
* circumstances.
|
|
*
|
|
- * @param meta
|
|
- * @param material
|
|
+ * @param meta meta
|
|
+ * @param material material
|
|
* @return updated material
|
|
- * @throws IllegalArgumentException
|
|
+ * @throws IllegalArgumentException exception
|
|
* @deprecated for internal use only
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/inventory/Merchant.java b/src/main/java/org/bukkit/inventory/Merchant.java
|
|
index c8e68570f..45431b360 100644
|
|
--- a/src/main/java/org/bukkit/inventory/Merchant.java
|
|
+++ b/src/main/java/org/bukkit/inventory/Merchant.java
|
|
@@ -0,0 +0,0 @@ public interface Merchant {
|
|
*
|
|
* @param i the index
|
|
* @return the recipe
|
|
- * @throws IndexOutOfBoundsException
|
|
+ * @throws IndexOutOfBoundsException Throws when specified index is larger than Merchant's inventory
|
|
*/
|
|
MerchantRecipe getRecipe(int i) throws IndexOutOfBoundsException;
|
|
|
|
@@ -0,0 +0,0 @@ public interface Merchant {
|
|
*
|
|
* @param i the index
|
|
* @param recipe the recipe
|
|
- * @throws IndexOutOfBoundsException
|
|
+ * @throws IndexOutOfBoundsException Throws when specified index is larger than Merchant's inventory
|
|
*/
|
|
void setRecipe(int i, MerchantRecipe recipe) throws IndexOutOfBoundsException;
|
|
|
|
diff --git a/src/main/java/org/bukkit/potion/Potion.java b/src/main/java/org/bukkit/potion/Potion.java
|
|
index 1413b361b..b4a8051cc 100644
|
|
--- a/src/main/java/org/bukkit/potion/Potion.java
|
|
+++ b/src/main/java/org/bukkit/potion/Potion.java
|
|
@@ -0,0 +0,0 @@ public class Potion {
|
|
}
|
|
|
|
/**
|
|
+ * @param name Unused, always uses {@link PotionType#WATER}
|
|
* @deprecated
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/potion/PotionBrewer.java b/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
index 40f8d12b9..33d192287 100644
|
|
--- a/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
+++ b/src/main/java/org/bukkit/potion/PotionBrewer.java
|
|
@@ -0,0 +0,0 @@ public interface PotionBrewer {
|
|
* a potion with the given type.
|
|
*
|
|
* @param type The type of the potion
|
|
+ * @param upgraded Whether the potion is upgraded
|
|
+ * @param extended Whether the potion is extended
|
|
* @return The list of effects
|
|
*/
|
|
public Collection<PotionEffect> getEffects(PotionType type, boolean upgraded, boolean extended);
|
|
diff --git a/src/main/java/org/bukkit/potion/PotionType.java b/src/main/java/org/bukkit/potion/PotionType.java
|
|
index 034421a76..f1a54c23c 100644
|
|
--- a/src/main/java/org/bukkit/potion/PotionType.java
|
|
+++ b/src/main/java/org/bukkit/potion/PotionType.java
|
|
@@ -0,0 +0,0 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @return Damage value associated with this PotionType, broken
|
|
* @deprecated Non-functional
|
|
*/
|
|
@Deprecated
|
|
@@ -0,0 +0,0 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @param damage Damage value associated with a PotionType
|
|
+ * @return PotionType for given damage value, broken
|
|
* @deprecated Non-functional
|
|
*/
|
|
@Deprecated
|
|
@@ -0,0 +0,0 @@ public enum PotionType {
|
|
}
|
|
|
|
/**
|
|
+ * @param effectType EffectType
|
|
+ * @return Associated PotionType
|
|
* @deprecated Misleading
|
|
*/
|
|
@Deprecated
|
|
diff --git a/src/main/java/org/bukkit/scoreboard/Team.java b/src/main/java/org/bukkit/scoreboard/Team.java
|
|
index ab71f3c31..358ea386b 100644
|
|
--- a/src/main/java/org/bukkit/scoreboard/Team.java
|
|
+++ b/src/main/java/org/bukkit/scoreboard/Team.java
|
|
@@ -0,0 +0,0 @@ public interface Team {
|
|
* names are handled by prefixes / suffixes.
|
|
*
|
|
* @return team color, defaults to {@link ChatColor#RESET}
|
|
- * @throws IllegalStateException
|
|
+ * @throws IllegalStateException if this team has been unregistered
|
|
*/
|
|
ChatColor getColor() throws IllegalStateException;
|
|
|
|
--
|