From 488a8f1e8105c44da43f98e9d1d42e9031cd406e Mon Sep 17 00:00:00 2001 From: Tastybento Date: Sat, 17 Feb 2018 16:30:06 -0800 Subject: [PATCH] JavaDoc fixes --- pom.xml | 6 +- .../askyblock/ASkyBlockAPI.java | 36 +++---- .../wasteofplastic/askyblock/CoopPlay.java | 4 +- .../wasteofplastic/askyblock/Messages.java | 16 ++-- .../wasteofplastic/askyblock/PlayerCache.java | 94 +++++++++---------- .../wasteofplastic/askyblock/SafeBoat.java | 6 +- .../wasteofplastic/askyblock/Scoreboards.java | 4 +- src/com/wasteofplastic/askyblock/TinyDB.java | 4 +- .../wasteofplastic/askyblock/WarpSigns.java | 8 +- .../askyblock/commands/AdminCmd.java | 4 +- .../askyblock/commands/IslandCmd.java | 10 +- .../askyblock/events/IslandDeleteEvent.java | 2 +- .../askyblock/listeners/AcidEffect.java | 4 +- .../askyblock/listeners/AcidInventory.java | 8 +- .../askyblock/listeners/ChatListener.java | 14 +-- .../askyblock/listeners/EntityLimits.java | 8 +- .../askyblock/listeners/FlyingMobEvents.java | 4 +- .../askyblock/listeners/IslandGuard.java | 40 ++++---- .../askyblock/listeners/IslandGuard1_8.java | 4 +- .../askyblock/listeners/IslandGuard1_9.java | 14 +-- .../askyblock/listeners/LavaCheck.java | 4 +- .../askyblock/listeners/NetherPortals.java | 8 +- .../askyblock/listeners/PlayerEvents.java | 28 +++--- .../askyblock/panels/WarpPanel.java | 8 +- 24 files changed, 169 insertions(+), 169 deletions(-) diff --git a/pom.xml b/pom.xml index c3e079792..7136fc01f 100644 --- a/pom.xml +++ b/pom.xml @@ -89,6 +89,9 @@ org.apache.maven.plugins maven-javadoc-plugin 3.0.0 + + -Xdoclint:none + attach-javadocs @@ -97,9 +100,6 @@ - - false - diff --git a/src/com/wasteofplastic/askyblock/ASkyBlockAPI.java b/src/com/wasteofplastic/askyblock/ASkyBlockAPI.java index 74305afc0..0abe61b8f 100644 --- a/src/com/wasteofplastic/askyblock/ASkyBlockAPI.java +++ b/src/com/wasteofplastic/askyblock/ASkyBlockAPI.java @@ -70,7 +70,7 @@ protected ASkyBlockAPI(ASkyBlock plugin) { } /** - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return Map of all of the known challenges with a boolean marking * them as complete (true) or incomplete (false). This is a view of the * challenges map that only allows read operations. @@ -80,7 +80,7 @@ public Map getChallengeStatus(UUID playerUUID) { } /** - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return Map of all of the known challenges and how many times each * one has been completed. This is a view of the challenges * map that only allows read operations. @@ -101,7 +101,7 @@ public Location getHomeLocation(UUID playerUUID) { * Returns the island level from the last time it was calculated. Note this * does not calculate the island level. * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return the last level calculated for the island or zero if none. */ public int getIslandLevel(UUID playerUUID) { @@ -112,7 +112,7 @@ public int getIslandLevel(UUID playerUUID) { * Returns the island level from the last time it was calculated. Note this * does not calculate the island level. * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return the last level calculated for the island or zero if none. */ public long getLongIslandLevel(UUID playerUUID) { @@ -132,7 +132,7 @@ public long getLongIslandLevel(UUID playerUUID) { * You will need to check if the player is in a team and individually set the level of each team member. * This value will be overwritten if the players run the build-in level command or if the island level * is calculated some other way, e.g. at login or via an admin command. - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param level - level to set */ public void setIslandLevel(UUID playerUUID, int level) { @@ -145,7 +145,7 @@ public void setIslandLevel(UUID playerUUID, int level) { * or use getIslandLevel(playerUUID). See https://gist.github.com/tastybento/e81d2403c03f2fe26642 * for example code. * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return true if player has an island, false if not */ public boolean calculateIslandLevel(UUID playerUUID) { @@ -160,7 +160,7 @@ public boolean calculateIslandLevel(UUID playerUUID) { * Provides the location of the player's island, either the team island or * their own * - * @param playerUUID - players UUID + * @param playerUUID - the player's UUID - players UUID * @return Location of island */ public Location getIslandLocation(UUID playerUUID) { @@ -181,7 +181,7 @@ public UUID getOwner(Location location) { /** * Get Team Leader * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return UUID of Team Leader or null if there is none. Use inTeam to * check. */ @@ -193,7 +193,7 @@ public UUID getTeamLeader(UUID playerUUID) { * Get a list of team members. This is a copy and changing the return value * will not affect the membership. * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return List of team members, including the player. Empty if there are * none. */ @@ -204,7 +204,7 @@ public List getTeamMembers(UUID playerUUID) { /** * Provides location of the player's warp sign * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return Location of sign or null if one does not exist */ public Location getWarp(UUID playerUUID) { @@ -226,7 +226,7 @@ public String getWarpOwner(Location location) { * Status of island ownership. Team members do not have islands of their * own, only leaders do. * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return true if player has an island, false if the player does not. */ public boolean hasIsland(UUID playerUUID) { @@ -234,7 +234,7 @@ public boolean hasIsland(UUID playerUUID) { } /** - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return true if in a team */ public boolean inTeam(UUID playerUUID) { @@ -342,7 +342,7 @@ public boolean setIslandBiome(Location islandLoc, Biome biomeType) { /** * Sets a message for the player to receive next time they login * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param message - message to set * @return true if player is offline, false if online */ @@ -354,7 +354,7 @@ public boolean setMessage(UUID playerUUID, String message) { * Sends a message to every player in the team that is offline If the player * is not in a team, nothing happens. * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param message - message to send */ public void tellOfflineTeam(UUID playerUUID, String message) { @@ -458,7 +458,7 @@ public Map getLongTopTen() { /** * Obtains a copy of the island object owned by playerUUID - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return copy of Island object */ public Island getIslandOwnedBy(UUID playerUUID) { @@ -527,7 +527,7 @@ public LinkedHashMap> getAllChallenges(){ /** * Get the number of resets left for this player - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return Number of resets left */ public int getResetsLeft(UUID playerUUID) { @@ -536,7 +536,7 @@ public int getResetsLeft(UUID playerUUID) { /** * Set the number of resets left for this player - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param resets - number to set */ public void setResetsLeft(UUID playerUUID, int resets) { @@ -545,7 +545,7 @@ public void setResetsLeft(UUID playerUUID, int resets) { /** * Find out if this player is a team leader or not. If the player is not in a team, the result will always be false. - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return true if the player is in a team and is the leader */ public boolean isLeader(UUID playerUUID) { diff --git a/src/com/wasteofplastic/askyblock/CoopPlay.java b/src/com/wasteofplastic/askyblock/CoopPlay.java index 3830cbe90..0808325d2 100644 --- a/src/com/wasteofplastic/askyblock/CoopPlay.java +++ b/src/com/wasteofplastic/askyblock/CoopPlay.java @@ -258,7 +258,7 @@ public void loadCoops() { /** * Gets a serialize list of all the coops for this player. Used when saving the player - * @param playerUUID + * @param playerUUID - the player's UUID * @return List of island location | uuid of invitee */ private List getMyCoops(UUID playerUUID) { @@ -273,7 +273,7 @@ private List getMyCoops(UUID playerUUID) { /** * Sets a player's coops from string. Used when loading a player. - * @param playerUUID + * @param playerUUID - the player's UUID * @param coops */ private void setMyCoops(UUID playerUUID, List coops) { diff --git a/src/com/wasteofplastic/askyblock/Messages.java b/src/com/wasteofplastic/askyblock/Messages.java index 0dc0b4b21..b2a353477 100644 --- a/src/com/wasteofplastic/askyblock/Messages.java +++ b/src/com/wasteofplastic/askyblock/Messages.java @@ -51,7 +51,7 @@ public Messages(ASkyBlock plugin) { /** * Returns what messages are waiting for the player or null if none * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return List of messages */ public List getMessages(UUID playerUUID) { @@ -62,7 +62,7 @@ public List getMessages(UUID playerUUID) { /** * Clears any messages for player * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID */ public void clearMessages(UUID playerUUID) { messages.remove(playerUUID); @@ -114,7 +114,7 @@ public boolean loadMessages() { /** * Provides the messages for the player * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return List of messages */ public List get(UUID playerUUID) { @@ -124,7 +124,7 @@ public List get(UUID playerUUID) { /** * Stores a message for player * - * @param playerUUID + * @param playerUUID - the player's UUID * @param playerMessages */ public void put(UUID playerUUID, List playerMessages) { @@ -135,7 +135,7 @@ public void put(UUID playerUUID, List playerMessages) { /** * Sends a message to every player in the team that is offline * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param message - message to send */ public void tellOfflineTeam(UUID playerUUID, String message) { @@ -158,7 +158,7 @@ public void tellOfflineTeam(UUID playerUUID, String message) { /** * Tells all online team members something happened * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param message - message to send */ public void tellTeam(UUID playerUUID, String message) { @@ -181,7 +181,7 @@ public void tellTeam(UUID playerUUID, String message) { /** * Sets a message for the player to receive next time they login * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param message - message to set * @return true if player is offline, false if online */ @@ -201,7 +201,7 @@ public boolean setMessage(UUID playerUUID, String message) { /** * Stores a message without any online check - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param message - message to store */ public void storeMessage(UUID playerUUID, String message) { diff --git a/src/com/wasteofplastic/askyblock/PlayerCache.java b/src/com/wasteofplastic/askyblock/PlayerCache.java index e183f95ce..68c79df72 100644 --- a/src/com/wasteofplastic/askyblock/PlayerCache.java +++ b/src/com/wasteofplastic/askyblock/PlayerCache.java @@ -134,7 +134,7 @@ public void removeAllPlayers() { /** * Returns location of player's island from cache if available * - * @param playerUUID + * @param playerUUID - the player's UUID * @return Location of player's island */ /* @@ -149,7 +149,7 @@ public void removeAllPlayers() { /** * Checks if the player is known or not by looking through the filesystem * - * @param uniqueID + * @param uniqueId - unique ID * @return true if player is know, otherwise false */ public boolean isAKnownPlayer(final UUID uniqueID) { @@ -172,7 +172,7 @@ public boolean isAKnownPlayer(final UUID uniqueID) { /** * Returns the player object for the named player * - * @param playerUUID + * @param playerUUID - the player's UUID * - String name of player * @return - player object */ @@ -184,7 +184,7 @@ public Players get(UUID playerUUID) { /** * Checks if player has island from cache if available * - * @param playerUUID + * @param playerUUID - the player's UUID * - string name of player * @return true if player has island */ @@ -198,7 +198,7 @@ public boolean hasIsland(final UUID playerUUID) { /** * Checks if player is in a Team from cache if available * - * @param playerUUID + * @param playerUUID - the player's UUID * @return true if player in a team */ public boolean inTeam(final UUID playerUUID) { @@ -210,7 +210,7 @@ public boolean inTeam(final UUID playerUUID) { * Removes any island associated with this player and generally cleans up * the player * - * @param playerUUID + * @param playerUUID - the player's UUID */ public void zeroPlayerData(UUID playerUUID) { addPlayer(playerUUID); @@ -244,7 +244,7 @@ public void zeroPlayerData(UUID playerUUID) { /** * Sets the home location for the player - * @param playerUUID + * @param playerUUID - the player's UUID * @param location * @param number - 1 is default. Can be any number. */ @@ -255,7 +255,7 @@ public void setHomeLocation(UUID playerUUID, Location location, int number) { /** * Set the default home location for player - * @param playerUUID + * @param playerUUID - the player's UUID * @param location */ public void setHomeLocation(UUID playerUUID, Location location) { @@ -265,7 +265,7 @@ public void setHomeLocation(UUID playerUUID, Location location) { /** * Clears any home locations for player - * @param playerUUID + * @param playerUUID - the player's UUID */ public void clearHomeLocations(UUID playerUUID) { addPlayer(playerUUID); @@ -275,7 +275,7 @@ public void clearHomeLocations(UUID playerUUID) { /** * Returns the home location, or null if none * - * @param playerUUID + * @param playerUUID - the player's UUID * @param number * @return Home location or null if none */ @@ -286,7 +286,7 @@ public Location getHomeLocation(UUID playerUUID, int number) { /** * Gets the default home location for player - * @param playerUUID + * @param playerUUID - the player's UUID * @return Home location or null if none */ public Location getHomeLocation(UUID playerUUID) { @@ -296,7 +296,7 @@ public Location getHomeLocation(UUID playerUUID) { /** * Provides all home locations for player - * @param playerUUID + * @param playerUUID - the player's UUID * @return List of home locations */ public HashMap getHomeLocations(UUID playerUUID) { @@ -308,7 +308,7 @@ public HashMap getHomeLocations(UUID playerUUID) { * Returns the player's island location. * Returns an island location OR a team island location * - * @param playerUUID + * @param playerUUID - the player's UUID * @return Location of player's island */ public Location getIslandLocation(UUID playerUUID) { @@ -347,7 +347,7 @@ public void setTeamIslandLocation(UUID playerUUID, Location islandLocation) { /** * Checks if a challenge has been completed or not * - * @param playerUUID + * @param playerUUID - the player's UUID * @param challenge * @return true if complete */ @@ -359,7 +359,7 @@ public boolean checkChallenge(UUID playerUUID, String challenge) { /** * Checks how often a challenge has been completed * - * @param playerUUID + * @param playerUUID - the player's UUID * @param challenge * @return number of times */ @@ -371,7 +371,7 @@ public int checkChallengeTimes(UUID playerUUID, String challenge) { /** * Provides the status of all challenges for this player * - * @param playerUUID + * @param playerUUID - the player's UUID * @return Hashmap of challenges as key, boolean as state */ public HashMap getChallengeStatus(UUID playerUUID) { @@ -382,7 +382,7 @@ public HashMap getChallengeStatus(UUID playerUUID) { /** * How many times a challenge has been completed * - * @param playerUUID + * @param playerUUID - the player's UUID * @return map of completion times */ public HashMap getChallengeTimes(UUID playerUUID) { @@ -398,7 +398,7 @@ public void resetChallenge(UUID playerUUID, String challenge) { /** * Resets all the player's challenges. If the boolean is true, then everything will be reset, if false * challenges that have the "resetallowed: false" flag in challenges.yml will not be reset - * @param playerUUID + * @param playerUUID - the player's UUID * @param resetAll */ public void resetAllChallenges(UUID playerUUID, boolean resetAll) { @@ -418,7 +418,7 @@ public void resetAllChallenges(UUID playerUUID, boolean resetAll) { /** * Puts a player in a team - * @param playerUUID + * @param playerUUID - the player's UUID * @param teamLeader * @param islandLocation * @return true if successful, false if not @@ -432,7 +432,7 @@ public boolean setJoinTeam(UUID playerUUID, UUID teamLeader, Location islandLoca /** * Called when a player leaves a team Resets inTeam, teamLeader, * islandLevel, teamIslandLocation, islandLocation and members array - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return - true if successful */ public boolean setLeaveTeam(UUID playerUUID) { @@ -444,7 +444,7 @@ public boolean setLeaveTeam(UUID playerUUID) { * Returns a list of team member UUID's. If the player is not the leader, * then the leader's list is used * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return List of team UUIDs */ public List getMembers(UUID playerUUID) { @@ -478,7 +478,7 @@ public void removeMember(UUID teamLeader, UUID playerUUID) { /** * Provides UUID of this player's team leader or null if it does not exist - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return UUID of leader */ public UUID getTeamLeader(UUID playerUUID) { @@ -489,7 +489,7 @@ public UUID getTeamLeader(UUID playerUUID) { /** * Saves the player's info to the file system * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID */ public void save(UUID playerUUID) { playerCache.get(playerUUID).save(); @@ -555,7 +555,7 @@ public UUID getUUID(String string, boolean adminCheck) { /** * Sets the player's name and updates the name to UUID database so it is up to date - * @param uniqueId - player's UUID + * @param uniqueId - unique ID - player's UUID * @param name - name to set */ public void setPlayerName(UUID uniqueId, String name) { @@ -572,7 +572,7 @@ public void setPlayerName(UUID uniqueId, String name) { * Obtains the name of the player from their UUID * Player must have logged into the game before * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return String - playerName */ public String getName(UUID playerUUID) { @@ -608,7 +608,7 @@ public UUID getPlayerFromIslandLocation(Location loc) { /** * Gets how many island resets the player has left * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return number of resets */ public int getResetsLeft(UUID playerUUID) { @@ -619,7 +619,7 @@ public int getResetsLeft(UUID playerUUID) { /** * Sets how many resets the player has left * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param resets - value to set */ public void setResetsLeft(UUID playerUUID, int resets) { @@ -631,7 +631,7 @@ public void setResetsLeft(UUID playerUUID, int resets) { * Returns how long the player must wait before they can be invited to an * island with the location * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param location - location to query * @return time to wait in minutes/hours */ @@ -645,7 +645,7 @@ public long getInviteCoolDownTime(UUID playerUUID, Location location) { * be invited * Called when they are kicked from an island or leave. * - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param location - location to set */ public void startInviteCoolDownTimer(UUID playerUUID, Location location) { @@ -655,7 +655,7 @@ public void startInviteCoolDownTimer(UUID playerUUID, Location location) { /** * Returns the locale for this player. If missing, will return nothing - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return name of the locale this player uses */ public String getLocale(UUID playerUUID) { @@ -668,7 +668,7 @@ public String getLocale(UUID playerUUID) { /** * Sets the locale this player wants to use - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param localeName - locale to set */ public void setLocale(UUID playerUUID, String localeName) { @@ -678,7 +678,7 @@ public void setLocale(UUID playerUUID, String localeName) { /** * The rating of the initial starter island out of 100. Default is 50 - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return rating the rating */ public int getStartIslandRating(UUID playerUUID) { @@ -688,7 +688,7 @@ public int getStartIslandRating(UUID playerUUID) { /** * Record the island rating that the player started with - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param rating the rating */ public void setStartIslandRating(UUID playerUUID, int rating) { @@ -698,7 +698,7 @@ public void setStartIslandRating(UUID playerUUID, int rating) { /** * Clear the starter island rating from the player's record - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID */ public void clearStartIslandRating(UUID playerUUID) { setStartIslandRating(playerUUID, 0); @@ -706,7 +706,7 @@ public void clearStartIslandRating(UUID playerUUID) { /** * Ban target from a player's island - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param targetUUID - target's UUID */ public void ban(UUID playerUUID, UUID targetUUID) { @@ -728,7 +728,7 @@ public void ban(UUID playerUUID, UUID targetUUID) { /** * Unban target from player's island - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param targetUUID - target's UUID */ public void unBan(UUID playerUUID, UUID targetUUID) { @@ -749,7 +749,7 @@ public void unBan(UUID playerUUID, UUID targetUUID) { } /** - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param targetUUID - target's UUID * @return true if target is banned from player's island */ @@ -780,7 +780,7 @@ public boolean isBanned(UUID playerUUID, UUID targetUUID) { } /** - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return ban list for player */ public List getBanList(UUID playerUUID) { @@ -800,7 +800,7 @@ public void clearResets(int resetLimit) { /** * Sets whether the player uses the control panel or not when doing /island - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param b - true = user control panel */ public void setControlPanel(UUID playerUUID, boolean b) { @@ -811,7 +811,7 @@ public void setControlPanel(UUID playerUUID, boolean b) { /** * Gets whether the player uses the control panel or not when doing /island - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return true if they use the control panel */ public boolean getControlPanel(UUID playerUUID) { @@ -822,7 +822,7 @@ public boolean getControlPanel(UUID playerUUID) { /** * Map storing whether a player is officially teleporting or not - * @param uniqueId - player's UUID + * @param uniqueId - unique ID - player's UUID * @param b - true if player is teleporting */ public void setInTeleport(UUID uniqueId, boolean b) { @@ -835,7 +835,7 @@ public void setInTeleport(UUID uniqueId, boolean b) { /** * Checks whether player with UUID uniqueId is in an official teleport or not - * @param uniqueId - player's UUID + * @param uniqueId - unique ID - player's UUID * @return true if in teleport */ public boolean isInTeleport(UUID uniqueId) { @@ -844,7 +844,7 @@ public boolean isInTeleport(UUID uniqueId) { /** * Add death to player - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID */ public void addDeath(UUID playerUUID) { addPlayer(playerUUID); @@ -853,7 +853,7 @@ public void addDeath(UUID playerUUID) { /** * Set death number for player - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @param deaths - number of deaths */ public void setDeaths(UUID playerUUID, int deaths) { @@ -863,7 +863,7 @@ public void setDeaths(UUID playerUUID, int deaths) { /** * Get number of times player has died in ASkyBlock worlds since counting began - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return number of deaths */ public int getDeaths(UUID playerUUID) { @@ -872,7 +872,7 @@ public int getDeaths(UUID playerUUID) { } /** - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return List of challenges or levels done */ public List getChallengesDone(UUID playerUUID) { @@ -881,7 +881,7 @@ public List getChallengesDone(UUID playerUUID) { } /** - * @param playerUUID - player's UUID + * @param playerUUID - the player's UUID - player's UUID * @return List of challenges or levels not done */ public List getChallengesNotDone(UUID playerUUID) { diff --git a/src/com/wasteofplastic/askyblock/SafeBoat.java b/src/com/wasteofplastic/askyblock/SafeBoat.java index 712c37ec5..5a65062eb 100644 --- a/src/com/wasteofplastic/askyblock/SafeBoat.java +++ b/src/com/wasteofplastic/askyblock/SafeBoat.java @@ -58,7 +58,7 @@ public SafeBoat(ASkyBlock aSkyBlock) { } /** - * @param e + * @param e - event * This event check throws the boat at a player when they hit it * unless someone is in it */ @@ -102,7 +102,7 @@ public void onClick(VehicleDamageEvent e) { } /** - * @param e + * @param e - event * This function prevents boats from exploding when they hit * something */ @@ -165,7 +165,7 @@ public void onTeleport(final PlayerTeleportEvent e) { } /** - * @param e + * @param e - event * This event aims to put the player in a safe place when they * exit the boat */ diff --git a/src/com/wasteofplastic/askyblock/Scoreboards.java b/src/com/wasteofplastic/askyblock/Scoreboards.java index 6734ec653..bd8e2379b 100644 --- a/src/com/wasteofplastic/askyblock/Scoreboards.java +++ b/src/com/wasteofplastic/askyblock/Scoreboards.java @@ -55,7 +55,7 @@ public static Scoreboards getInstance() { /** * Puts a player into a team of their own and sets the team suffix to be the level - * @param playerUUID + * @param playerUUID - the player's UUID */ public void setLevel(UUID playerUUID) { Player player = plugin.getServer().getPlayer(playerUUID); @@ -81,7 +81,7 @@ public void setLevel(UUID playerUUID) { /** * Sets the player's level explicitly - * @param playerUUID + * @param playerUUID - the player's UUID * @param l */ public void setLevel(UUID playerUUID, long l) { diff --git a/src/com/wasteofplastic/askyblock/TinyDB.java b/src/com/wasteofplastic/askyblock/TinyDB.java index 94753006b..8f02744bf 100644 --- a/src/com/wasteofplastic/askyblock/TinyDB.java +++ b/src/com/wasteofplastic/askyblock/TinyDB.java @@ -193,7 +193,7 @@ public boolean isDbReady() { /** * Saves the player name to the database. Case insensitive! * @param playerName - * @param playerUUID + * @param playerUUID - the player's UUID */ public void savePlayerName(String playerName, UUID playerUUID) { if (playerName == null) { @@ -242,7 +242,7 @@ public UUID getPlayerUUID(String playerName) { /** * Gets players name from tiny database - * @param playerUuid + * @param playerUUID - the player's UUID * @return Name or empty string if unknown */ public String getPlayerName(UUID playerUuid) { diff --git a/src/com/wasteofplastic/askyblock/WarpSigns.java b/src/com/wasteofplastic/askyblock/WarpSigns.java index 4673ac548..c54a76c88 100644 --- a/src/com/wasteofplastic/askyblock/WarpSigns.java +++ b/src/com/wasteofplastic/askyblock/WarpSigns.java @@ -69,7 +69,7 @@ public WarpSigns(ASkyBlock plugin) { /** * Checks to see if a sign has been broken - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = false) public void onSignBreak(BlockBreakEvent e) { @@ -112,7 +112,7 @@ public void onSignBreak(BlockBreakEvent e) { /** * Event handler for Sign Changes * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = false) public void onSignWarpCreate(SignChangeEvent e) { @@ -281,7 +281,7 @@ public void loadWarpList() { /** * Stores warps in the warp array * - * @param playerUUID + * @param playerUUID - the player's UUID * @param loc */ public boolean addWarp(final UUID playerUUID, final Location loc) { @@ -431,7 +431,7 @@ public Collection listSortedWarps() { /** * Provides the location of the warp for player or null if one is not found * - * @param playerUUID + * @param playerUUID - the player's UUID * - the warp requested * @return Location of warp */ diff --git a/src/com/wasteofplastic/askyblock/commands/AdminCmd.java b/src/com/wasteofplastic/askyblock/commands/AdminCmd.java index 2e1cf0aec..8039754be 100644 --- a/src/com/wasteofplastic/askyblock/commands/AdminCmd.java +++ b/src/com/wasteofplastic/askyblock/commands/AdminCmd.java @@ -2309,7 +2309,7 @@ public static Location getClosestIsland(Location location) { /** * Shows info on a player * - * @param playerUUID + * @param playerUUID - the player's UUID * @param sender */ private void showInfo(UUID playerUUID, CommandSender sender) { @@ -2415,7 +2415,7 @@ private void showInfo(UUID playerUUID, CommandSender sender) { /** * Shows info on the challenge situation for player * - * @param playerUUID + * @param playerUUID - the player's UUID * @param sender */ private void showInfoChallenges(UUID playerUUID, CommandSender sender) { diff --git a/src/com/wasteofplastic/askyblock/commands/IslandCmd.java b/src/com/wasteofplastic/askyblock/commands/IslandCmd.java index 5c1f25298..258cc23f6 100644 --- a/src/com/wasteofplastic/askyblock/commands/IslandCmd.java +++ b/src/com/wasteofplastic/askyblock/commands/IslandCmd.java @@ -493,7 +493,7 @@ private void tip() { /** * Adds a player to a team. The player and the teamleader MAY be the same * - * @param playerUUID + * @param playerUUID - the player's UUID * @param teamLeader * @return true if the player is successfully added */ @@ -542,7 +542,7 @@ public boolean addPlayertoTeam(final UUID playerUUID, final UUID teamLeader) { /** * Removes a player from a team run by teamleader * - * @param playerUUID + * @param playerUUID - the player's UUID * @param teamLeader * @return true if successful, false if not */ @@ -553,7 +553,7 @@ public boolean removePlayerFromTeam(final UUID playerUUID, final UUID teamLeader /** * Removes a player from a team run by teamleader * - * @param playerUUID + * @param playerUUID - the player's UUID * @param teamLeader * @param makeLeader - true if this is the result of switching leader * @return true if successful, false if not @@ -837,7 +837,7 @@ public void pasteSchematic(final Schematic schematic, final Location loc, final /** * Get the location of next free island spot - * @param playerUUID + * @param playerUUID - the player's UUID * @return Location of island spot */ private Location getNextIsland(UUID playerUUID) { @@ -3332,7 +3332,7 @@ private long getLevelWaitTime(final Player player) { /** * Reserves a spot in the world for the player to have their island placed next time they make one - * @param playerUUID + * @param playerUUID - the player's UUID * @param location */ public void reserveLocation(UUID playerUUID, Location location) { diff --git a/src/com/wasteofplastic/askyblock/events/IslandDeleteEvent.java b/src/com/wasteofplastic/askyblock/events/IslandDeleteEvent.java index 0ad892ca0..37b2ac586 100644 --- a/src/com/wasteofplastic/askyblock/events/IslandDeleteEvent.java +++ b/src/com/wasteofplastic/askyblock/events/IslandDeleteEvent.java @@ -35,7 +35,7 @@ public class IslandDeleteEvent extends Event { private final Location location; /** - * @param playerUUID + * @param playerUUID - the player's UUID * @param oldLocation */ public IslandDeleteEvent(UUID playerUUID, Location oldLocation) { diff --git a/src/com/wasteofplastic/askyblock/listeners/AcidEffect.java b/src/com/wasteofplastic/askyblock/listeners/AcidEffect.java index 3db79ee75..41ef777f3 100644 --- a/src/com/wasteofplastic/askyblock/listeners/AcidEffect.java +++ b/src/com/wasteofplastic/askyblock/listeners/AcidEffect.java @@ -351,7 +351,7 @@ private boolean isSafeFromAcid(Player player) { /** * Enables changing of obsidian back into lava * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL) public void onPlayerInteract(final PlayerInteractEvent e) { @@ -474,7 +474,7 @@ else if (chest.getType() == Material.DIAMOND_CHESTPLATE) /** * Tracks weather changes and acid rain * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL) public void onWeatherChange(final WeatherChangeEvent e) { diff --git a/src/com/wasteofplastic/askyblock/listeners/AcidInventory.java b/src/com/wasteofplastic/askyblock/listeners/AcidInventory.java index 9bdd119f9..cd447dac9 100644 --- a/src/com/wasteofplastic/askyblock/listeners/AcidInventory.java +++ b/src/com/wasteofplastic/askyblock/listeners/AcidInventory.java @@ -62,7 +62,7 @@ public AcidInventory(ASkyBlock aSkyBlock) { /** * This covers items in a chest, etc. inventory, then change the name then * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onInventoryOpen(InventoryOpenEvent e) { @@ -130,7 +130,7 @@ public void onInventoryOpen(InventoryOpenEvent e) { /** * If the player filled up the bucket themselves * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onBucketFill(PlayerBucketFillEvent e) { @@ -155,7 +155,7 @@ public void onBucketFill(PlayerBucketFillEvent e) { /** * Checks to see if a player is drinking acid * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onWaterBottleDrink(final PlayerItemConsumeEvent e) { @@ -191,7 +191,7 @@ public void onWaterBottleDrink(final PlayerItemConsumeEvent e) { * This event makes sure that any acid bottles become potions without the * warning * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onBrewComplete(final BrewEvent e) { diff --git a/src/com/wasteofplastic/askyblock/listeners/ChatListener.java b/src/com/wasteofplastic/askyblock/listeners/ChatListener.java index 0871a3c24..949605967 100644 --- a/src/com/wasteofplastic/askyblock/listeners/ChatListener.java +++ b/src/com/wasteofplastic/askyblock/listeners/ChatListener.java @@ -182,7 +182,7 @@ private void teamChat(final AsyncPlayerChatEvent event, String message) { /** * Adds player to team chat - * @param playerUUID + * @param playerUUID - the player's UUID */ public void setPlayer(UUID playerUUID) { this.teamChatUsers.put(playerUUID,true); @@ -190,7 +190,7 @@ public void setPlayer(UUID playerUUID) { /** * Removes player from team chat - * @param playerUUID + * @param playerUUID - the player's UUID */ public void unSetPlayer(UUID playerUUID) { this.teamChatUsers.remove(playerUUID); @@ -198,7 +198,7 @@ public void unSetPlayer(UUID playerUUID) { /** * Whether the player has team chat on or not - * @param playerUUID + * @param playerUUID - the player's UUID * @return true if team chat is on */ public boolean isTeamChat(UUID playerUUID) { @@ -207,7 +207,7 @@ public boolean isTeamChat(UUID playerUUID) { /** * Store the player's level for use in their chat tag - * @param playerUUID + * @param playerUUID - the player's UUID * @param l */ public void setPlayerLevel(UUID playerUUID, long l) { @@ -226,7 +226,7 @@ public void setPlayerChallengeLevel(Player player) { /** * Return the player's level for use in chat - async safe - * @param playerUUID + * @param playerUUID - the player's UUID * @return Player's level as string */ public String getPlayerLevel(UUID playerUUID) { @@ -235,7 +235,7 @@ public String getPlayerLevel(UUID playerUUID) { /** * Return the player's challenge level for use in chat - async safe - * @param playerUUID + * @param playerUUID - the player's UUID * @return challenge level as string or empty string none */ public String getPlayerChallengeLevel(UUID playerUUID) { @@ -246,7 +246,7 @@ public String getPlayerChallengeLevel(UUID playerUUID) { /** * Toggles team chat spy. Spy must also have the spy permission to see chats - * @param playerUUID + * @param playerUUID - the player's UUID * @return true if toggled on, false if toggled off */ public boolean toggleSpy(UUID playerUUID) { diff --git a/src/com/wasteofplastic/askyblock/listeners/EntityLimits.java b/src/com/wasteofplastic/askyblock/listeners/EntityLimits.java index f6260b560..ba1742b22 100644 --- a/src/com/wasteofplastic/askyblock/listeners/EntityLimits.java +++ b/src/com/wasteofplastic/askyblock/listeners/EntityLimits.java @@ -218,7 +218,7 @@ public void onAnimalSpawn(final CreatureSpawnEvent e) { /** * Prevents mobs spawning naturally at spawn or in an island * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onNaturalMobSpawn(final CreatureSpawnEvent e) { @@ -325,7 +325,7 @@ public void onPlayerBlockPlace(final BlockMultiPlaceEvent e) { /** * Prevents placing of blocks * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onPlayerBlockPlace(final BlockPlaceEvent e) { @@ -441,7 +441,7 @@ public void onPlayerBlockPlace(final HangingPlaceEvent e) { /** * Prevents trees from growing outside of the protected area. * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onTreeGrow(final StructureGrowEvent e) { @@ -531,7 +531,7 @@ public void onVillagerSpawn(final CreatureSpawnEvent e) { /** * Handles minecart placing - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onMinecart(VehicleCreateEvent e) { diff --git a/src/com/wasteofplastic/askyblock/listeners/FlyingMobEvents.java b/src/com/wasteofplastic/askyblock/listeners/FlyingMobEvents.java index 0762d137c..62fa1041a 100644 --- a/src/com/wasteofplastic/askyblock/listeners/FlyingMobEvents.java +++ b/src/com/wasteofplastic/askyblock/listeners/FlyingMobEvents.java @@ -91,7 +91,7 @@ public void run() { /** * Track where the mob was created. This will determine its allowable movement zone. - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void mobSpawn(CreatureSpawnEvent e) { @@ -199,7 +199,7 @@ public void WitherExplode(ExplosionPrimeEvent e) { /** * Withers change blocks to air after they are hit (don't know why) * This prevents this when the wither has been spawned by a visitor - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void WitherChangeBlocks(EntityChangeBlockEvent e) { diff --git a/src/com/wasteofplastic/askyblock/listeners/IslandGuard.java b/src/com/wasteofplastic/askyblock/listeners/IslandGuard.java index bde1b973f..19cb2b8b7 100644 --- a/src/com/wasteofplastic/askyblock/listeners/IslandGuard.java +++ b/src/com/wasteofplastic/askyblock/listeners/IslandGuard.java @@ -391,7 +391,7 @@ public void onVehicleMove(final VehicleMoveEvent e) { /** * Adds island lock function * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onPlayerMove(final PlayerMoveEvent e) { @@ -694,7 +694,7 @@ public void onEndermanGrief(final EntityChangeBlockEvent e) { /** * Drops the Enderman's block when he dies if he has one * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onEndermanDeath(final EntityDeathEvent e) { @@ -733,7 +733,7 @@ public void onBlockBreakCheck(final BlockPhysicsEvent e) { /** * Prevents blocks from being broken * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onBlockBreak(final BlockBreakEvent e) { @@ -804,7 +804,7 @@ public void onItemFrameDamage(final HangingBreakByEntityEvent e) { * This method protects players from PVP if it is not allowed and from * arrows fired by other players * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onEntityDamage(final EntityDamageByEntityEvent e) { @@ -1001,7 +1001,7 @@ public void onEntityDamage(final EntityDamageByEntityEvent e) { /** * Sets spawners to their type - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onSpawnerBlockPlace(final BlockPlaceEvent e) { @@ -1078,7 +1078,7 @@ public void onPlayerBedEnter(final PlayerBedEnterEvent e) { /** * Prevents the breakage of hanging items * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW) public void onBreakHanging(final HangingBreakByEntityEvent e) { @@ -1132,7 +1132,7 @@ public void onBreakHanging(final HangingBreakByEntityEvent e) { /** * Prevents the leash use * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW) public void onLeashUse(final PlayerLeashEntityEvent e) { @@ -1156,7 +1156,7 @@ public void onLeashUse(final PlayerLeashEntityEvent e) { /** * Prevents the leash use * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW) public void onLeashUse(final PlayerUnleashEntityEvent e) { @@ -1224,7 +1224,7 @@ public void onLiquidFlow(final BlockFromToEvent e) { /** * Prevents emptying of buckets outside of island space - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onBucketEmpty(final PlayerBucketEmptyEvent e) { @@ -1271,7 +1271,7 @@ public void onBucketEmpty(final PlayerBucketEmptyEvent e) { /** * Prevents water from being dispensed in hell biomes * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW) public void onNetherDispenser(final BlockDispenseEvent e) { @@ -1352,7 +1352,7 @@ public void onShear(final PlayerShearEntityEvent e) { /** * Handles interaction with objects * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onPlayerInteract(final PlayerInteractEvent e) { @@ -2034,7 +2034,7 @@ public void onFishing(PlayerFishEvent e) { /** * Handles hitting minecarts or feeding animals - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onPlayerHitEntity(PlayerInteractEntityEvent e) { @@ -2215,7 +2215,7 @@ public void onPlayerHitEntity(PlayerInteractEntityEvent e) { /** * Prevents fire spread - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onBlockBurn(BlockBurnEvent e) { @@ -2234,7 +2234,7 @@ public void onBlockBurn(BlockBurnEvent e) { /** * Prevent fire spread - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onBlockSpread(BlockSpreadEvent e) { @@ -2347,7 +2347,7 @@ public void run() { /** * Pressure plates - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onPlateStep(PlayerInteractEvent e) { @@ -2382,7 +2382,7 @@ public void onPlateStep(PlayerInteractEvent e) { /** * Removes the player from the plate map - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW) public void onStepOffPlate(PlayerMoveEvent e) { @@ -2422,7 +2422,7 @@ public void onPistonExtend(BlockPistonExtendEvent e) { /** * Handle visitor chicken egg throwing - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onEggThrow(PlayerEggThrowEvent e) { @@ -2449,7 +2449,7 @@ public void onEggThrow(PlayerEggThrowEvent e) { /** * Trap TNT being primed by flaming arrows - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onTNTPrimed(final EntityChangeBlockEvent e) { @@ -2515,7 +2515,7 @@ public void run() { /** * Stop redstone if team members are offline and disableOfflineRedstone is TRUE. - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onBlockRedstone(BlockRedstoneEvent e){ @@ -2581,7 +2581,7 @@ public void onEvent(BlockPistonRetractEvent event) /** * Checks for splash damage. If there is any to any affected entity and it's not allowed, it won't work on any of them. - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled=true) public void onSplashPotionSplash(final PotionSplashEvent e) { diff --git a/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_8.java b/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_8.java index c10801a3f..57be68d5e 100644 --- a/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_8.java +++ b/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_8.java @@ -81,7 +81,7 @@ private boolean actionAllowed(Player player, Location location, SettingsFlag fla * Handle interaction with armor stands V1.8 * Note - some armor stand protection is done in IslandGuard.java, e.g. against projectiles. * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled=true) public void onPlayerInteract(final PlayerInteractAtEntityEvent e) { @@ -105,7 +105,7 @@ public void onPlayerInteract(final PlayerInteractAtEntityEvent e) { * Tilling of coarse dirt into dirt * Usually prevented because it could lead to an endless supply of dirt with gravel * - * @param e + * @param e - event */ @SuppressWarnings("deprecation") @EventHandler(priority = EventPriority.LOW, ignoreCancelled=true) diff --git a/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_9.java b/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_9.java index 1d1b31eb7..06c0c38b4 100644 --- a/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_9.java +++ b/src/com/wasteofplastic/askyblock/listeners/IslandGuard1_9.java @@ -100,7 +100,7 @@ public IslandGuard1_9(final ASkyBlock plugin) { /** * Handles Frost Walking on visitor's islands - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled=true) public void onBlockForm(EntityBlockFormEvent e) { @@ -138,7 +138,7 @@ public void onBlockForm(EntityBlockFormEvent e) { /** * Handle interaction with end crystals 1.9 * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled=true) public void onHitEndCrystal(final PlayerInteractAtEntityEvent e) { @@ -221,7 +221,7 @@ void placeEndCrystalEvent(PlayerInteractEvent e) { /** * Handle end crystal damage by visitors - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled=true) public void EndCrystalDamage(EntityDamageByEntityEvent e) { @@ -291,7 +291,7 @@ public void EndCrystalDamage(EntityDamageByEntityEvent e) { /** * Handles end crystal explosions - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onExplosion(final EntityExplodeEvent e) { @@ -345,7 +345,7 @@ public void onExplosion(final EntityExplodeEvent e) { /** * Triggers a push protection change or not - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onPlayerJoin(final PlayerJoinEvent e) { @@ -361,7 +361,7 @@ public void onPlayerJoin(final PlayerJoinEvent e) { /** * Triggers scoreboard cleanup on Quit - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL,ignoreCancelled = true) public void onPlayerQuit(PlayerQuitEvent e) @@ -437,7 +437,7 @@ private void removePush(Player player) * Tilling of coarse dirt into dirt using off-hand (regular hand is in 1.8) * Usually prevented because it could lead to an endless supply of dirt with gravel * - * @param e + * @param e - event */ @SuppressWarnings("deprecation") @EventHandler(priority = EventPriority.LOW, ignoreCancelled=true) diff --git a/src/com/wasteofplastic/askyblock/listeners/LavaCheck.java b/src/com/wasteofplastic/askyblock/listeners/LavaCheck.java index e7e5a44e4..2f99bccf7 100644 --- a/src/com/wasteofplastic/askyblock/listeners/LavaCheck.java +++ b/src/com/wasteofplastic/askyblock/listeners/LavaCheck.java @@ -63,7 +63,7 @@ public LavaCheck(ASkyBlock aSkyBlock) { /** * Removes stone generated by lava pouring onto water * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onCleanstoneGen(BlockFromToEvent e) { @@ -107,7 +107,7 @@ public void run() { /** * Magic Cobble Generator - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOWEST, ignoreCancelled = true) public void onCobbleGen(BlockFromToEvent e){ diff --git a/src/com/wasteofplastic/askyblock/listeners/NetherPortals.java b/src/com/wasteofplastic/askyblock/listeners/NetherPortals.java index 697142051..c0f324a76 100644 --- a/src/com/wasteofplastic/askyblock/listeners/NetherPortals.java +++ b/src/com/wasteofplastic/askyblock/listeners/NetherPortals.java @@ -282,7 +282,7 @@ private boolean awayFromSpawn(Player player) { /** * Prevents blocks from being broken * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW) public void onBlockBreak(final BlockBreakEvent e) { @@ -307,7 +307,7 @@ public void onBlockBreak(final BlockBreakEvent e) { /** * Prevents placing of blocks * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW) public void onPlayerBlockPlace(final BlockPlaceEvent e) { @@ -346,7 +346,7 @@ public void onBucketEmpty(final PlayerBucketEmptyEvent e) { /** * Prevent the Nether spawn from being blown up * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onExplosion(final EntityExplodeEvent e) { @@ -374,7 +374,7 @@ public void onExplosion(final EntityExplodeEvent e) { /** * Converts trees to gravel and glowstone * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onTreeGrow(final StructureGrowEvent e) { diff --git a/src/com/wasteofplastic/askyblock/listeners/PlayerEvents.java b/src/com/wasteofplastic/askyblock/listeners/PlayerEvents.java index 07a911d58..f2e73e004 100644 --- a/src/com/wasteofplastic/askyblock/listeners/PlayerEvents.java +++ b/src/com/wasteofplastic/askyblock/listeners/PlayerEvents.java @@ -137,7 +137,7 @@ public void giveAllTempPerms() { /** * Prevents changing of hunger while having a special permission and being on your island - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onHungerChange(final FoodLevelChangeEvent e) { @@ -159,7 +159,7 @@ public void onHungerChange(final FoodLevelChangeEvent e) { /** * Gives temporary perms * Gives flymode if player has a specific permission and is on his island - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onPlayerEnterOnIsland(IslandEnterEvent e){ @@ -240,7 +240,7 @@ public void onPlayerJoin(final PlayerJoinEvent event) { /** * Revoke temporary perms * Removes flymode with a delay if player leave his island. - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.NORMAL, ignoreCancelled = true) public void onPlayerLeaveIsland(IslandExitEvent e) { @@ -368,7 +368,7 @@ public void onPlayerLeave(PlayerQuitEvent event){ /** * Places player back on their island if the setting is true - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) public void onPlayerRespawn(final PlayerRespawnEvent e) { @@ -397,7 +397,7 @@ public void onPlayerRespawn(final PlayerRespawnEvent e) { /** * Registers death of player. * Places the player on the island respawn list if set - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.LOW, ignoreCancelled = true) public void onPlayerDeath(final PlayerDeathEvent e) { @@ -532,7 +532,7 @@ public void onPlayerFall(final PlayerMoveEvent e) { /** * Prevents teleporting when falling based on setting by stopping commands * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) public void onPlayerTeleport(final PlayerCommandPreprocessEvent e) { @@ -558,7 +558,7 @@ public void onPlayerTeleport(final PlayerCommandPreprocessEvent e) { /** * Prevents teleporting when falling based on setting and teleporting to locked islands * - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.HIGH, ignoreCancelled = true) public void onPlayerTeleport(final PlayerTeleportEvent e) { @@ -825,7 +825,7 @@ public void onPlayerTeleport(final PlayerTeleportEvent e) { /** * Used to prevent teleporting when falling * - * @param uniqueId + * @param uniqueId - unique ID * @return true or false */ public static boolean isFalling(UUID uniqueId) { @@ -835,7 +835,7 @@ public static boolean isFalling(UUID uniqueId) { /** * Used to prevent teleporting when falling * - * @param uniqueId + * @param uniqueId - unique ID */ public static void setFalling(UUID uniqueId) { fallingPlayers.add(uniqueId); @@ -844,7 +844,7 @@ public static void setFalling(UUID uniqueId) { /** * Unset the falling flag * - * @param uniqueId + * @param uniqueId - unique ID */ public static void unsetFalling(UUID uniqueId) { // getLogger().info("DEBUG: unset falling"); @@ -853,7 +853,7 @@ public static void unsetFalling(UUID uniqueId) { /** * Prevents visitors from using commands on islands, like /spawner - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) public void onVisitorCommand(final PlayerCommandPreprocessEvent e) { @@ -878,7 +878,7 @@ public void onVisitorCommand(final PlayerCommandPreprocessEvent e) { /** * Prevents visitors from getting damage if invinciblevisitors option is set to TRUE - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) public void onVisitorGetDamage(EntityDamageByEntityEvent e){ @@ -927,7 +927,7 @@ public void onVisitorGetDamage(EntityDamageByEntityEvent e){ /** * Prevents visitors from getting damage if invinciblevisitors option is set to TRUE - * @param e + * @param e - event */ @EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) public void onVisitorGetDamage(EntityDamageEvent e){ @@ -972,7 +972,7 @@ else if(e.getCause().equals(DamageCause.VOID)) { /** * Protect players from damage when teleporting - * @param e + * @param e - event */ public void onPlayerTeleportDamage(EntityDamageEvent e){ if(!(e.getEntity() instanceof Player)) return; diff --git a/src/com/wasteofplastic/askyblock/panels/WarpPanel.java b/src/com/wasteofplastic/askyblock/panels/WarpPanel.java index 6a313a2f5..515cec11d 100644 --- a/src/com/wasteofplastic/askyblock/panels/WarpPanel.java +++ b/src/com/wasteofplastic/askyblock/panels/WarpPanel.java @@ -74,7 +74,7 @@ public WarpPanel(ASkyBlock plugin) { /** * Only change the text of the warp - * @param playerUUID + * @param playerUUID - the player's UUID */ public void updateWarp(UUID playerUUID) { if (DEBUG) @@ -105,7 +105,7 @@ public void updateAllWarpText() { } /** * Adds a new warp to the cache. Does NOT update the panels - * @param playerUUID + * @param playerUUID - the player's UUID */ public void addWarp(UUID playerUUID) { if (DEBUG) @@ -133,7 +133,7 @@ public void addWarp(UUID playerUUID) { /** * Gets the skull for this player UUID - * @param playerUUID + * @param playerUUID - the player's UUID * @return Player skull item */ private ItemStack getSkull(UUID playerUUID) { @@ -158,7 +158,7 @@ private ItemStack getSkull(UUID playerUUID) { * Updates the meta text on the skull by looking at the warp sign * This MUST be run 1 TICK AFTER the sign has been created otherwise the sign is blank * @param playerSkull - * @param playerUUID + * @param playerUUID - the player's UUID * @return updated skull item stack */ private ItemStack updateText(ItemStack playerSkull, final UUID playerUUID) {