From 272be6b392b3c9aeabbc86160ccb37bf18dcfa6f Mon Sep 17 00:00:00 2001 From: Daniel Saukel Date: Sat, 28 Jul 2018 21:15:58 +0200 Subject: [PATCH] Javadoc fixes --- pom.xml | 2 +- .../de/erethon/dungeonsxl/DungeonsXL.java | 49 ++++++--- .../dungeonsxl/announcer/Announcer.java | 65 +++++------ .../dungeonsxl/announcer/AnnouncerCache.java | 10 +- .../erethon/dungeonsxl/config/DMessage.java | 7 +- .../erethon/dungeonsxl/config/MainConfig.java | 79 +++++--------- .../erethon/dungeonsxl/dungeon/Dungeon.java | 27 +++-- .../dungeonsxl/dungeon/DungeonCache.java | 12 +-- .../dungeonsxl/dungeon/DungeonConfig.java | 38 +++---- .../event/dgroup/DGroupCreateEvent.java | 6 +- .../event/dgroup/DGroupDisbandEvent.java | 6 +- .../dungeonsxl/event/dgroup/DGroupEvent.java | 3 +- .../dgroup/DGroupFinishDungeonEvent.java | 3 +- .../event/dgroup/DGroupFinishFloorEvent.java | 6 +- .../event/dgroup/DGroupRewardEvent.java | 12 +-- .../event/dgroup/DGroupScoreEvent.java | 6 +- .../event/dgroup/DGroupStartFloorEvent.java | 3 +- .../dungeonsxl/event/dmob/DMobDeathEvent.java | 3 +- .../dungeonsxl/event/dmob/DMobEvent.java | 3 +- .../event/dplayer/DPlayerEvent.java | 3 +- .../event/dplayer/DPlayerKickEvent.java | 3 +- .../instance/DInstancePlayerUpdateEvent.java | 15 +-- .../instance/game/DGamePlayerDeathEvent.java | 6 +- .../instance/game/DGamePlayerFinishEvent.java | 3 +- .../dungeonsxl/event/dsign/DSignEvent.java | 3 +- .../event/dsign/DSignRegistrationEvent.java | 6 +- .../event/editworld/EditWorldEvent.java | 3 +- .../event/editworld/EditWorldLoadEvent.java | 3 +- .../event/editworld/EditWorldUnloadEvent.java | 3 +- .../event/gameworld/GameWorldEvent.java | 3 +- .../event/gameworld/GameWorldLoadEvent.java | 3 +- .../gameworld/GameWorldStartGameEvent.java | 3 +- .../requirement/RequirementCheckEvent.java | 3 +- .../requirement/RequirementDemandEvent.java | 3 +- .../event/requirement/RequirementEvent.java | 3 +- .../event/reward/RewardAdditionEvent.java | 3 +- .../dungeonsxl/event/reward/RewardEvent.java | 3 +- .../trigger/TriggerRegistrationEvent.java | 3 +- .../java/de/erethon/dungeonsxl/game/Game.java | 47 +++----- .../de/erethon/dungeonsxl/game/GameGoal.java | 12 +-- .../dungeonsxl/game/GameRuleProvider.java | 64 ++++------- .../de/erethon/dungeonsxl/game/GameType.java | 36 +++---- .../dungeonsxl/game/GameTypeCache.java | 8 +- .../de/erethon/dungeonsxl/global/DPortal.java | 22 ++-- .../erethon/dungeonsxl/global/GameSign.java | 14 ++- .../dungeonsxl/global/GlobalProtection.java | 9 +- .../global/GlobalProtectionCache.java | 28 +++-- .../erethon/dungeonsxl/global/GroupSign.java | 10 +- .../erethon/dungeonsxl/global/JoinSign.java | 12 +-- .../erethon/dungeonsxl/global/LeaveSign.java | 4 +- .../dungeonsxl/mob/CitizensMobProvider.java | 6 +- .../de/erethon/dungeonsxl/mob/DMobType.java | 48 +++------ .../erethon/dungeonsxl/mob/DNPCRegistry.java | 6 +- .../dungeonsxl/mob/ExternalMobProvider.java | 21 ++-- .../mob/ExternalMobProviderCache.java | 10 +- .../de/erethon/dungeonsxl/player/DClass.java | 9 +- .../dungeonsxl/player/DClassCache.java | 7 +- .../dungeonsxl/player/DEditPlayer.java | 9 +- .../dungeonsxl/player/DGamePlayer.java | 64 ++++------- .../dungeonsxl/player/DGlobalPlayer.java | 40 +++---- .../de/erethon/dungeonsxl/player/DGroup.java | 101 +++++++----------- .../dungeonsxl/player/DInstancePlayer.java | 13 +-- .../dungeonsxl/player/DPermission.java | 14 ++- .../dungeonsxl/player/DPlayerCache.java | 20 ++-- .../dungeonsxl/player/DPlayerData.java | 66 ++++-------- .../requirement/FeeLevelRequirement.java | 3 +- .../requirement/FeeMoneyRequirement.java | 3 +- .../requirement/GroupSizeRequirement.java | 6 +- .../requirement/PermissionRequirement.java | 3 +- .../requirement/RequirementTypeCache.java | 13 +-- .../erethon/dungeonsxl/reward/ItemReward.java | 9 +- .../dungeonsxl/reward/LevelReward.java | 6 +- .../dungeonsxl/reward/MoneyReward.java | 6 +- .../dungeonsxl/reward/RewardTypeCache.java | 7 +- .../erethon/dungeonsxl/sign/BossShopSign.java | 3 +- .../de/erethon/dungeonsxl/sign/ChestSign.java | 12 +-- .../de/erethon/dungeonsxl/sign/DSign.java | 15 +-- .../dungeonsxl/sign/DSignTypeCache.java | 6 +- .../de/erethon/dungeonsxl/sign/DropSign.java | 3 +- .../de/erethon/dungeonsxl/sign/FloorSign.java | 3 +- .../dungeonsxl/sign/LivesModifierSign.java | 3 +- .../erethon/dungeonsxl/sign/LocationSign.java | 3 +- .../erethon/dungeonsxl/sign/OpenDoorSign.java | 6 +- .../dungeonsxl/sign/PerPlayerSign.java | 6 +- .../erethon/dungeonsxl/sign/RedstoneSign.java | 27 ++--- .../dungeonsxl/sign/ResourcePackSign.java | 3 +- .../erethon/dungeonsxl/sign/SignScript.java | 21 ++-- .../dungeonsxl/sign/SignScriptCache.java | 7 +- .../de/erethon/dungeonsxl/sign/WaveSign.java | 6 +- .../dungeonsxl/sign/lobby/ClassesSign.java | 3 +- .../dungeonsxl/sign/lobby/ReadySign.java | 6 +- .../dungeonsxl/sign/lobby/StartSign.java | 3 +- .../sign/message/ActionBarSign.java | 6 +- .../dungeonsxl/sign/message/TitleSign.java | 12 +-- .../dungeonsxl/sign/mob/ExternalMobSign.java | 12 +-- .../erethon/dungeonsxl/sign/mob/MobSign.java | 24 ++--- .../dungeonsxl/trigger/FortuneTrigger.java | 3 +- .../dungeonsxl/trigger/ProgressTrigger.java | 9 +- .../erethon/dungeonsxl/trigger/Trigger.java | 12 +-- .../dungeonsxl/trigger/TriggerTypeCache.java | 7 +- .../dungeonsxl/trigger/WaveTrigger.java | 4 +- .../de/erethon/dungeonsxl/util/DColor.java | 6 +- .../de/erethon/dungeonsxl/util/GUIUtil.java | 25 ++--- .../de/erethon/dungeonsxl/util/LWCUtil.java | 3 +- .../de/erethon/dungeonsxl/util/NoReload.java | 3 +- .../erethon/dungeonsxl/util/ParsingUtil.java | 7 +- .../erethon/dungeonsxl/util/ProgressBar.java | 6 +- .../erethon/dungeonsxl/world/DEditWorld.java | 26 ++--- .../erethon/dungeonsxl/world/DGameWorld.java | 62 +++++------ .../dungeonsxl/world/DInstanceWorld.java | 16 +-- .../dungeonsxl/world/DResourceWorld.java | 23 ++-- .../erethon/dungeonsxl/world/DWorldCache.java | 42 ++++---- .../de/erethon/dungeonsxl/world/SignData.java | 20 +--- .../erethon/dungeonsxl/world/WorldConfig.java | 20 ++-- .../dungeonsxl/world/block/GameBlock.java | 6 +- .../dungeonsxl/world/block/MultiBlock.java | 3 +- .../dungeonsxl/world/block/RewardChest.java | 15 +-- .../dungeonsxl/world/block/TeamBlock.java | 3 +- 118 files changed, 624 insertions(+), 1058 deletions(-) diff --git a/pom.xml b/pom.xml index 8c6c0199..10096610 100644 --- a/pom.xml +++ b/pom.xml @@ -2,7 +2,7 @@ 4.0.0 de.erethon dungeonsxl - 0.16 + 0.16.1-SNAPSHOT jar DungeonsXL https://dre2n.github.io diff --git a/src/main/java/de/erethon/dungeonsxl/DungeonsXL.java b/src/main/java/de/erethon/dungeonsxl/DungeonsXL.java index f3c96c5e..7f4e2770 100644 --- a/src/main/java/de/erethon/dungeonsxl/DungeonsXL.java +++ b/src/main/java/de/erethon/dungeonsxl/DungeonsXL.java @@ -56,8 +56,7 @@ import org.bukkit.event.HandlerList; import org.bukkit.inventory.Inventory; /** - * The main class of DungeonsXL. - * It contains several important instances and the actions when the plugin is enabled / disabled. + * The main class of DungeonsXL. It contains several important instances and the actions when the plugin is enabled / disabled. * * @author Frank Baumann, Tobias Schmitz, Daniel Saukel */ @@ -282,6 +281,8 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of GlobalData + * + * @param file the file to load from */ public void loadGlobalData(File file) { globalData = new GlobalData(file); @@ -296,6 +297,8 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of MainConfig + * + * @param file the file to load from */ public void loadMainConfig(File file) { mainConfig = new MainConfig(file); @@ -303,6 +306,8 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of MessageConfig + * + * @param file the file to load from */ public void loadMessageConfig(File file) { messageConfig = new MessageConfig(DMessage.class, file); @@ -403,9 +408,11 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of DungeonCache + * + * @param folder the folder to load from */ - public void loadDungeons(File file) { - dungeons = new DungeonCache(file); + public void loadDungeons(File folder) { + dungeons = new DungeonCache(folder); } /** @@ -459,9 +466,11 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of AnnouncerCache + * + * @param folder the folder to load from */ - public void loadAnnouncers(File file) { - announcers = new AnnouncerCache(file); + public void loadAnnouncers(File folder) { + announcers = new AnnouncerCache(folder); } /** @@ -473,26 +482,32 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of DClasseCache + * + * @param folder the folder to load from */ - public void loadDClasses(File file) { - dClasses = new DClassCache(file); + public void loadDClasses(File folder) { + dClasses = new DClassCache(folder); } /** * load / reload loot tables + * + * @param folder the folder to load from */ - public void loadLootTables(File file) { - for (File script : FileUtil.getFilesForFolder(file)) { + public void loadLootTables(File folder) { + for (File script : FileUtil.getFilesForFolder(folder)) { new LootTable(caliburn, script); } } /** * load / reload DMob types + * + * @param folder the folder to load from */ - public void loadMobs(File file) { - if (file.isDirectory()) { - for (File script : FileUtil.getFilesForFolder(file)) { + public void loadMobs(File folder) { + if (folder.isDirectory()) { + for (File script : FileUtil.getFilesForFolder(folder)) { caliburn.getExMobs().add(new DMobType(script)); } } @@ -508,9 +523,11 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of SignScriptCache + * + * @param folder the folder to load from */ - public void loadSignScripts(File file) { - signScripts = new SignScriptCache(file); + public void loadSignScripts(File folder) { + signScripts = new SignScriptCache(folder); } /** @@ -522,6 +539,8 @@ public class DungeonsXL extends DREPlugin { /** * load / reload a new instance of DWorldCache + * + * @param folder the folder to load from */ public void loadDWorlds(File folder) { dWorlds = new DWorldCache(MAPS); diff --git a/src/main/java/de/erethon/dungeonsxl/announcer/Announcer.java b/src/main/java/de/erethon/dungeonsxl/announcer/Announcer.java index 21b570e6..838d3625 100644 --- a/src/main/java/de/erethon/dungeonsxl/announcer/Announcer.java +++ b/src/main/java/de/erethon/dungeonsxl/announcer/Announcer.java @@ -73,18 +73,15 @@ public class Announcer { private AnnouncerStartGameTask startTask; /** - * @param file - * the script file + * @param file the script file */ public Announcer(File file) { this(file.getName().substring(0, file.getName().length() - 4), YamlConfiguration.loadConfiguration(file)); } /** - * @param name - * the name of the Announcer - * @param config - * the config that stores the information + * @param name the name of the Announcer + * @param config the config that stores the information */ public Announcer(String name, FileConfiguration config) { this.name = name; @@ -115,20 +112,13 @@ public class Announcer { } /** - * @param name - * the name of the Announcer - * @param description - * the description messages - * @param worlds - * the names of the worlds where the announcement will be seen or null to broadcast it to all worlds - * @param identifier - * the dungeon identifier - * @param multiFloor - * if the identifier refers to an MFD (true) or an SFD (false) - * @param maxGroupsPerGame - * the amount of groups in one game - * @param maxPlayersPerGame - * the amount of players in one group + * @param name the name of the Announcer + * @param description the description messages + * @param worlds the names of the worlds where the announcement will be seen or null to broadcast it to all worlds + * @param identifier the dungeon identifier + * @param multiFloor if the identifier refers to an MFD (true) or an SFD (false) + * @param maxGroupsPerGame the amount of groups in one game + * @param maxPlayersPerGroup the amount of players in one group */ public Announcer(String name, List description, List worlds, String identifier, boolean multiFloor, short maxGroupsPerGame, int maxPlayersPerGroup) { this.name = name; @@ -168,8 +158,7 @@ public class Announcer { } /** - * @param description - * the description to set + * @param description the description to set */ public void setDescription(List description) { this.description = description; @@ -183,8 +172,7 @@ public class Announcer { } /** - * @param worlds - * the worlds to set + * @param worlds the worlds to set */ public void setWorlds(List worlds) { this.worlds = worlds; @@ -198,8 +186,7 @@ public class Announcer { } /** - * @param dungeonName - * the name of the dungeon to set + * @param dungeonName the name of the dungeon to set */ public void setDungeonName(String dungeonName) { this.dungeonName = dungeonName; @@ -213,8 +200,7 @@ public class Announcer { } /** - * @param mapName - * the name of the map to set + * @param mapName the name of the map to set */ public void setMapName(String mapName) { this.mapName = mapName; @@ -228,8 +214,7 @@ public class Announcer { } /** - * @param amount - * the amount to set + * @param amount the amount to set */ public void setMinGroupsPerGame(int amount) { minGroupsPerGame = amount; @@ -243,8 +228,7 @@ public class Announcer { } /** - * @param amount - * the amount to set + * @param amount the amount to set */ public void setMinPlayersPerGroup(int amount) { minPlayersPerGroup = amount; @@ -258,8 +242,7 @@ public class Announcer { } /** - * @param amount - * the amount to set + * @param amount the amount to set */ public void setMaxGroupsPerGame(short amount) { maxGroupsPerGame = amount; @@ -287,8 +270,7 @@ public class Announcer { } /** - * @param amount - * the amount to set + * @param amount the amount to set */ public void setMaxPlayersPerGroup(int amount) { maxPlayersPerGroup = amount; @@ -325,6 +307,8 @@ public class Announcer { /** * Sends the announcement + * + * @param player the player */ public void send(Player player) { for (String message : description) { @@ -352,6 +336,8 @@ public class Announcer { /** * Shows the group selection GUI + * + * @param player the player */ public void showGUI(Player player) { updateButtons(); @@ -361,8 +347,8 @@ public class Announcer { } /** - * @param button - * the clicked button + * @param player the player + * @param button the clicked button */ public void clickGroupButton(Player player, ItemStack button) { DGroup dGroup = getDGroupByButton(button); @@ -452,8 +438,7 @@ public class Announcer { } /** - * @param button - * the button + * @param button the button * @return the matching DGroup */ public DGroup getDGroupByButton(ItemStack button) { diff --git a/src/main/java/de/erethon/dungeonsxl/announcer/AnnouncerCache.java b/src/main/java/de/erethon/dungeonsxl/announcer/AnnouncerCache.java index b9f1252d..74ebe3fb 100644 --- a/src/main/java/de/erethon/dungeonsxl/announcer/AnnouncerCache.java +++ b/src/main/java/de/erethon/dungeonsxl/announcer/AnnouncerCache.java @@ -50,6 +50,7 @@ public class AnnouncerCache { } /** + * @param name the name * @return the announcer that has the name */ public Announcer getByName(String name) { @@ -63,6 +64,7 @@ public class AnnouncerCache { } /** + * @param gui the gui * @return the announcer that has the GUI */ public Announcer getByGUI(Inventory gui) { @@ -83,16 +85,14 @@ public class AnnouncerCache { } /** - * @param announcer - * the Announcer to add + * @param announcer the Announcer to add */ public void addAnnouncer(Announcer announcer) { announcers.add(announcer); } /** - * @param announcer - * the Announcer to remove + * @param announcer the Announcer to remove */ public void removeAnnouncer(Announcer announcer) { announcers.remove(announcer); @@ -107,6 +107,8 @@ public class AnnouncerCache { /** * start a new AnnouncerTask + * + * @param period the period ticks */ public void startAnnouncerTask(long period) { if (!announcers.isEmpty()) { diff --git a/src/main/java/de/erethon/dungeonsxl/config/DMessage.java b/src/main/java/de/erethon/dungeonsxl/config/DMessage.java index 411a90eb..c44ba9e9 100644 --- a/src/main/java/de/erethon/dungeonsxl/config/DMessage.java +++ b/src/main/java/de/erethon/dungeonsxl/config/DMessage.java @@ -21,8 +21,7 @@ import org.bukkit.configuration.file.FileConfiguration; import org.bukkit.configuration.file.YamlConfiguration; /** - * An enumeration of all messages. - * The values are fetched from the language file. + * An enumeration of all messages. The values are fetched from the language file. * * @author Daniel Saukel */ @@ -263,8 +262,8 @@ public enum DMessage implements Message { /* Statics */ /** - * @param identifier - * the identifier to set + * @param identifier the identifier to set + * @return the message */ public static Message getByIdentifier(String identifier) { for (Message message : values()) { diff --git a/src/main/java/de/erethon/dungeonsxl/config/MainConfig.java b/src/main/java/de/erethon/dungeonsxl/config/MainConfig.java index ce286b6b..62e853e0 100644 --- a/src/main/java/de/erethon/dungeonsxl/config/MainConfig.java +++ b/src/main/java/de/erethon/dungeonsxl/config/MainConfig.java @@ -124,8 +124,7 @@ public class MainConfig extends DREConfig { } /** - * @param language - * the language to set + * @param language the language to set */ public void setLanguage(String language) { this.language = language; @@ -139,72 +138,63 @@ public class MainConfig extends DREConfig { } /** - * @param enabled - * if DungeonsXL should use economy features provided by Vault + * @param enabled if DungeonsXL should use economy features provided by Vault */ public void setEconomyEnabled(boolean enabled) { enableEconomy = enabled; } /** - * @return - * if the dungeon chat is enabled + * @return if the dungeon chat is enabled */ public boolean isChatEnabled() { return chatEnabled; } /** - * @param enabled - * if the dungeon chat is enabled + * @param enabled if the dungeon chat is enabled */ public void setChatEnabled(boolean enabled) { chatEnabled = enabled; } /** - * @return - * the game chat format + * @return the game chat format */ public String getChatFormatGame() { return chatFormatGame; } /** - * @param string - * the game chat format to set + * @param string the game chat format to set */ public void setChatFormatGame(String string) { chatFormatGame = string; } /** - * @return - * the group chat format + * @return the group chat format */ public String getChatFormatGroup() { return chatFormatGroup; } /** - * @param string - * the group chat format to set + * @param string the group chat format to set */ public void setChatFormatGroup(String string) { chatFormatGroup = string; } /** - * @return - * the chat spy format + * @return the chat spy format */ public String getChatFormatSpy() { return chatFormatSpy; } /** - * @param string - * the chat spy format to set + * @param string the chat spy format to set */ public void setChatFormatSpy(String string) { chatFormatSpy = string; @@ -218,8 +208,7 @@ public class MainConfig extends DREConfig { } /** - * @param activated - * if new players start in a tutorial + * @param activated if new players start in a tutorial */ public void setTutorialActivated(boolean activated) { tutorialActivated = activated; @@ -233,8 +222,7 @@ public class MainConfig extends DREConfig { } /** - * @param dungeon - * the tutorial dungeon to set + * @param dungeon the tutorial dungeon to set */ public void setTutorialDungeon(String dungeon) { tutorialDungeon = dungeon; @@ -248,8 +236,7 @@ public class MainConfig extends DREConfig { } /** - * @param group - * the group the player gets when he plays the tutorial + * @param group the group the player gets when he plays the tutorial */ public void setTutorialStartGroup(String group) { tutorialStartGroup = group; @@ -263,8 +250,7 @@ public class MainConfig extends DREConfig { } /** - * @param group - * the group the player gets when he finshs the tutorial + * @param group the group the player gets when he finshs the tutorial */ public void setTutorialEndGroup(String group) { tutorialEndGroup = group; @@ -278,8 +264,7 @@ public class MainConfig extends DREConfig { } /** - * @param colors - * the colors to set + * @param colors the colors to set */ public void setGroupColorPriority(List colors) { groupColorPriority = colors; @@ -293,25 +278,21 @@ public class MainConfig extends DREConfig { } /** - * @param interval - * the interval to set + * @param interval the interval to set */ public void setAnnouncementInterval(double interval) { announcementInterval = interval; } /** - * @return - * false if death messages shall be sent to players who are not in the dungeon, - * true if not + * @return false if death messages shall be sent to players who are not in the dungeon, true if not */ public boolean areGlobalDeathMessagesDisabled() { return globalDeathMessagesDisabled; } /** - * @param disabled - * set if death messages shall be sent to players who are not in the dungeon + * @param disabled set if death messages shall be sent to players who are not in the dungeon */ public void setGlobalDeathMessagesDisabled(boolean disabled) { globalDeathMessagesDisabled = false; @@ -325,8 +306,7 @@ public class MainConfig extends DREConfig { } /** - * @param enabled - * if the floor title shall be sent + * @param enabled if the floor title shall be sent */ public void setSendFloorTitleEnabled(boolean enabled) { sendFloorTitle = enabled; @@ -354,8 +334,7 @@ public class MainConfig extends DREConfig { } /** - * @param maxInstances - * the maximum amount of worlds to instantiate at once + * @param maxInstances the maximum amount of worlds to instantiate at once */ public void setMaxInstances(int maxInstances) { this.maxInstances = maxInstances; @@ -369,8 +348,7 @@ public class MainConfig extends DREConfig { } /** - * @param enabled - * if the performance tweaks are enabled + * @param enabled if the performance tweaks are enabled */ public void setTweaksEnabled(boolean enabled) { tweaksEnabled = enabled; @@ -384,8 +362,7 @@ public class MainConfig extends DREConfig { } /** - * @param enabled - * if the secure mode is enabled + * @param enabled if the secure mode is enabled */ public void setSecureModeEnabled(boolean enabled) { secureModeEnabled = enabled; @@ -399,8 +376,7 @@ public class MainConfig extends DREConfig { } /** - * @param openInventories - * if inventories can be opened in edit mode + * @param openInventories if inventories can be opened in edit mode */ public void setOpenInventories(boolean openInventories) { this.openInventories = openInventories; @@ -414,8 +390,7 @@ public class MainConfig extends DREConfig { } /** - * @param dropItems - * if items may be dropped in edit mode + * @param dropItems if items may be dropped in edit mode */ public void setDropItems(boolean dropItems) { this.dropItems = dropItems; @@ -429,8 +404,7 @@ public class MainConfig extends DREConfig { } /** - * @param interval - * the interval for the check task + * @param interval the interval for the check task */ public void setSecureModeCheckInterval(double interval) { secureModeCheckInterval = interval; @@ -451,8 +425,7 @@ public class MainConfig extends DREConfig { } /** - * @param mode - * the BackupMode to set + * @param mode the BackupMode to set */ public void setBackupMode(BackupMode mode) { backupMode = mode; diff --git a/src/main/java/de/erethon/dungeonsxl/dungeon/Dungeon.java b/src/main/java/de/erethon/dungeonsxl/dungeon/Dungeon.java index 02a8b816..38fe7880 100644 --- a/src/main/java/de/erethon/dungeonsxl/dungeon/Dungeon.java +++ b/src/main/java/de/erethon/dungeonsxl/dungeon/Dungeon.java @@ -24,9 +24,8 @@ import java.util.Arrays; import java.util.List; /** - * Represents a dungeon. - * While multi floor dungeon scripts are represented by {@link de.erethon.dungeonsxl.config.DungeonConfig}, - * single floor dungeons also get a dungeon object without a config file as a placeholder. + * Represents a dungeon. While multi floor dungeon scripts are represented by {@link de.erethon.dungeonsxl.config.DungeonConfig}, single floor dungeons also get + * a dungeon object without a config file as a placeholder. * * @author Daniel Saukel */ @@ -38,6 +37,8 @@ public class Dungeon { /** * Real dungeon + * + * @param file the file to load from */ public Dungeon(File file) { name = file.getName().replaceAll(".yml", ""); @@ -47,6 +48,8 @@ public class Dungeon { /** * Artificial dungeon + * + * @param resource the only resource world */ public Dungeon(DResourceWorld resource) { name = resource.getName(); @@ -61,8 +64,7 @@ public class Dungeon { } /** - * @param name - * the name to set + * @param name the name to set */ public void setName(String name) { this.name = name; @@ -83,8 +85,7 @@ public class Dungeon { } /** - * @return - * the floors of the dungeon + * @return the floors of the dungeon */ public List getFloors() { if (isMultiFloor()) { @@ -95,16 +96,14 @@ public class Dungeon { } /** - * @return - * the SFD map / start floor + * @return the SFD map / start floor */ public DResourceWorld getMap() { return map; } /** - * @param map - * the SFD map / start floor to set + * @param map the SFD map / start floor to set */ public void setMap(DResourceWorld map) { this.map = map; @@ -124,10 +123,8 @@ public class Dungeon { /* Statics */ /** - * @param name - * the name of the dungeon - * @return - * the file. Might not exist + * @param name the name of the dungeon + * @return the file. Might not exist */ public static File getFileFromName(String name) { return new File(DungeonsXL.DUNGEONS, name + ".yml"); diff --git a/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonCache.java b/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonCache.java index c9b0134b..cf5fce2f 100644 --- a/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonCache.java +++ b/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonCache.java @@ -49,8 +49,7 @@ public class DungeonCache { } /** - * @param name - * the name of the Dungeon + * @param name the name of the Dungeon * @return the Dungeon that has the name */ public Dungeon getByName(String name) { @@ -71,8 +70,7 @@ public class DungeonCache { } /** - * @param name - * the name of the Dungeon + * @param name the name of the Dungeon * @return the Dungeon that has the name */ public Dungeon loadDungeon(String name) { @@ -82,16 +80,14 @@ public class DungeonCache { } /** - * @param dungeon - * the dungeon to add + * @param dungeon the dungeon to add */ public void addDungeon(Dungeon dungeon) { dungeons.add(dungeon); } /** - * @param dungeon - * the dungeon to remove + * @param dungeon the dungeon to remove */ public void removeDungeon(Dungeon dungeon) { dungeons.remove(dungeon); diff --git a/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonConfig.java b/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonConfig.java index 8d00202b..70a5d962 100644 --- a/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonConfig.java +++ b/src/main/java/de/erethon/dungeonsxl/dungeon/DungeonConfig.java @@ -61,8 +61,7 @@ public class DungeonConfig extends DREConfig { } /** - * @param startFloor - * the startFloor to set + * @param startFloor the startFloor to set */ public void setStartFloor(DResourceWorld startFloor) { this.startFloor = startFloor; @@ -76,8 +75,7 @@ public class DungeonConfig extends DREConfig { } /** - * @param endFloor - * the endFloor to set + * @param endFloor the endFloor to set */ public void setEndFloor(DResourceWorld endFloor) { this.endFloor = endFloor; @@ -91,16 +89,14 @@ public class DungeonConfig extends DREConfig { } /** - * @param resource - * the resource to add + * @param resource the resource to add */ public void addFloor(DResourceWorld resource) { floors.add(resource); } /** - * @param resource - * the resource to remove + * @param resource the resource to remove */ public void removeFloor(DResourceWorld resource) { floors.remove(resource); @@ -114,8 +110,7 @@ public class DungeonConfig extends DREConfig { } /** - * @param floorCount - * the floorCount to set + * @param floorCount the floorCount to set */ public void setFloorCount(int floorCount) { this.floorCount = floorCount; @@ -129,16 +124,14 @@ public class DungeonConfig extends DREConfig { } /** - * @param removeWhenPlayed - * the removeWhenPlayed to set + * @param removeWhenPlayed the removeWhenPlayed to set */ public void setRemoveWhenPlayed(boolean removeWhenPlayed) { this.removeWhenPlayed = removeWhenPlayed; } /** - * The values from this WorldConfig will override all values of the - * WorldConfigs of inherited maps. + * The values from this WorldConfig will override all values of the WorldConfigs of inherited maps. * * @return the override values */ @@ -147,17 +140,15 @@ public class DungeonConfig extends DREConfig { } /** - * @param worldConfig - * the WorldConfig to set + * @param worldConfig the WorldConfig to set */ public void setOverrideValues(WorldConfig worldConfig) { overrideValues = worldConfig; } /** - * The values from this WorldConfig will get overriden by values of the - * WorldConfigs of inherited maps. - * They will still override the values from the main config, though. + * The values from this WorldConfig will get overriden by values of the WorldConfigs of inherited maps. They will still override the values from the main + * config, though. * * @return the default values */ @@ -166,16 +157,14 @@ public class DungeonConfig extends DREConfig { } /** - * @param worldConfig - * the WorldConfig to set + * @param worldConfig the WorldConfig to set */ public void setDefaultValues(WorldConfig worldConfig) { defaultValues = worldConfig; } /** - * @param resource - * the DResourceWorld to check + * @param resource the DResourceWorld to check * @return true if the floor is either in the list or the start / end floor. */ public boolean containsFloor(DResourceWorld resource) { @@ -183,8 +172,7 @@ public class DungeonConfig extends DREConfig { } /** - * @param mapName - * the name of the map to check + * @param mapName the name of the map to check * @return true if the floor is either in the list or the start / end floor. */ public boolean containsFloor(String mapName) { diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupCreateEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupCreateEvent.java index 07e74d30..835b2e73 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupCreateEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupCreateEvent.java @@ -56,8 +56,7 @@ public class DGroupCreateEvent extends DGroupEvent implements Cancellable { } /** - * @param creator - * the creator to set + * @param creator the creator to set */ public void setCreator(Player creator) { this.creator = creator; @@ -71,8 +70,7 @@ public class DGroupCreateEvent extends DGroupEvent implements Cancellable { } /** - * @param cause - * the cause to set + * @param cause the cause to set */ public void setCause(Cause cause) { this.cause = cause; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupDisbandEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupDisbandEvent.java index 1cc13970..227bd38f 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupDisbandEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupDisbandEvent.java @@ -62,8 +62,7 @@ public class DGroupDisbandEvent extends DGroupEvent implements Cancellable { } /** - * @param disbander - * the disbander to set + * @param disbander the disbander to set */ public void setDisbander(Player disbander) { this.disbander = disbander; @@ -77,8 +76,7 @@ public class DGroupDisbandEvent extends DGroupEvent implements Cancellable { } /** - * @param cause - * the cause to set + * @param cause the cause to set */ public void setCause(Cause cause) { this.cause = cause; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupEvent.java index 34600416..af68394e 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupEvent.java @@ -38,8 +38,7 @@ public abstract class DGroupEvent extends Event { } /** - * @param dGroup - * the dGroup to set + * @param dGroup the dGroup to set */ public void setDGroup(DGroup dGroup) { this.dGroup = dGroup; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishDungeonEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishDungeonEvent.java index c73f80de..89aaea22 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishDungeonEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishDungeonEvent.java @@ -44,8 +44,7 @@ public class DGroupFinishDungeonEvent extends DGroupEvent implements Cancellable } /** - * @param dungeon - * the dungeon to set + * @param dungeon the dungeon to set */ public void setDisbander(Dungeon dungeon) { this.dungeon = dungeon; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishFloorEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishFloorEvent.java index f4e36009..86ab6e4e 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishFloorEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupFinishFloorEvent.java @@ -47,8 +47,7 @@ public class DGroupFinishFloorEvent extends DGroupEvent implements Cancellable { } /** - * @param finished - * the name of the DGameWorld to set + * @param finished the name of the DGameWorld to set */ public void setFinished(DGameWorld finished) { this.finished = finished; @@ -62,8 +61,7 @@ public class DGroupFinishFloorEvent extends DGroupEvent implements Cancellable { } /** - * @param next - * the resource to set + * @param next the resource to set */ public void setNext(DResourceWorld next) { this.next = next; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupRewardEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupRewardEvent.java index 1ffcb3cf..6b6287b5 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupRewardEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupRewardEvent.java @@ -48,16 +48,14 @@ public class DGroupRewardEvent extends DGroupEvent implements Cancellable { } /** - * @param reward - * the reward to add + * @param reward the reward to add */ public void addRewards(Reward reward) { rewards.add(reward); } /** - * @param reward - * the reward to remove + * @param reward the reward to remove */ public void removeRewards(Reward reward) { rewards.remove(reward); @@ -71,16 +69,14 @@ public class DGroupRewardEvent extends DGroupEvent implements Cancellable { } /** - * @param player - * the player to add + * @param player the player to add */ public void addExcludedPlayer(Player player) { excludedPlayers.add(player); } /** - * @param player - * the player to remove + * @param player the player to remove */ public void removeExcludedPlayer(Player player) { excludedPlayers.remove(player); diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupScoreEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupScoreEvent.java index 0c85b19f..694fd02c 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupScoreEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupScoreEvent.java @@ -46,8 +46,7 @@ public class DGroupScoreEvent extends DGroupEvent implements Cancellable { } /** - * @param scorer - * the scoerer to set + * @param scorer the scoerer to set */ public void setCreator(Player scorer) { this.scorer = scorer; @@ -61,8 +60,7 @@ public class DGroupScoreEvent extends DGroupEvent implements Cancellable { } /** - * @param loserGroup - * the group that lost a score to the scorers to set + * @param loserGroup the group that lost a score to the scorers to set */ public void setLoserGroup(DGroup loserGroup) { this.loserGroup = loserGroup; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupStartFloorEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupStartFloorEvent.java index d1487fe7..d97f3ba5 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupStartFloorEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dgroup/DGroupStartFloorEvent.java @@ -44,8 +44,7 @@ public class DGroupStartFloorEvent extends DGroupEvent implements Cancellable { } /** - * @param gameWorld - * the gameWorld to set + * @param gameWorld the gameWorld to set */ public void setGameWorld(DGameWorld gameWorld) { this.gameWorld = gameWorld; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobDeathEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobDeathEvent.java index 1d666024..4753d31b 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobDeathEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobDeathEvent.java @@ -44,8 +44,7 @@ public class DMobDeathEvent extends DMobEvent implements Cancellable { } /** - * @param bukkitEvent - * the bukkitEvent to set + * @param bukkitEvent the bukkitEvent to set */ public void setBukkitEvent(EntityDeathEvent bukkitEvent) { this.bukkitEvent = bukkitEvent; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobEvent.java index 18b98ebe..37b2e531 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dmob/DMobEvent.java @@ -38,8 +38,7 @@ public abstract class DMobEvent extends Event { } /** - * @param dMob - * the dMob to set + * @param dMob the dMob to set */ public void setDMob(DMob dMob) { this.dMob = dMob; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerEvent.java index 5092ad78..80ae0729 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerEvent.java @@ -38,8 +38,7 @@ public abstract class DPlayerEvent extends Event { } /** - * @param dPlayer - * the dPlayer to set + * @param dPlayer the dPlayer to set */ public void setDPlayer(DGlobalPlayer dPlayer) { this.dPlayer = dPlayer; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerKickEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerKickEvent.java index 384b9e69..65a1a968 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerKickEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dplayer/DPlayerKickEvent.java @@ -53,8 +53,7 @@ public class DPlayerKickEvent extends DPlayerEvent implements Cancellable { } /** - * @param cause - * the cause to set + * @param cause the cause to set */ public void setCause(Cause cause) { this.cause = cause; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/DInstancePlayerUpdateEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/DInstancePlayerUpdateEvent.java index 651059fa..6b6e1875 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/DInstancePlayerUpdateEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/DInstancePlayerUpdateEvent.java @@ -53,8 +53,7 @@ public class DInstancePlayerUpdateEvent extends DInstancePlayerEvent implements } /** - * @param locationValid - * set if the location is valid + * @param locationValid set if the location is valid */ public void setLocationValid(boolean locationValid) { this.locationValid = locationValid; @@ -68,8 +67,7 @@ public class DInstancePlayerUpdateEvent extends DInstancePlayerEvent implements } /** - * @param teleportWolf - * set if the wolf gets teleported + * @param teleportWolf set if the wolf gets teleported */ public void setTeleportWolf(boolean teleportWolf) { this.teleportWolf = teleportWolf; @@ -83,8 +81,7 @@ public class DInstancePlayerUpdateEvent extends DInstancePlayerEvent implements } /** - * @param respawnInventory - * respawn the player's old inventory on this update? + * @param respawnInventory respawn the player's old inventory on this update? */ public void setRespawnInventory(boolean respawnInventory) { this.respawnInventory = respawnInventory; @@ -105,8 +102,7 @@ public class DInstancePlayerUpdateEvent extends DInstancePlayerEvent implements } /** - * @param kick - * if the player gets kicked from the dungeon + * @param kick if the player gets kicked from the dungeon */ public void setKick(boolean kick) { this.kick = kick; @@ -120,8 +116,7 @@ public class DInstancePlayerUpdateEvent extends DInstancePlayerEvent implements } /** - * @param triggerAllInDistance - * the triggerAllInDistance to set + * @param triggerAllInDistance the triggerAllInDistance to set */ public void setTriggerAllInDistance(boolean triggerAllInDistance) { this.triggerAllInDistance = triggerAllInDistance; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerDeathEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerDeathEvent.java index ffdcc1dc..5e6d6917 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerDeathEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerDeathEvent.java @@ -46,8 +46,7 @@ public class DGamePlayerDeathEvent extends DGamePlayerEvent implements Cancellab } /** - * @param bukkitEvent - * the bukkitEvent to set + * @param bukkitEvent the bukkitEvent to set */ public void setBukkitEvent(PlayerDeathEvent bukkitEvent) { this.bukkitEvent = bukkitEvent; @@ -61,8 +60,7 @@ public class DGamePlayerDeathEvent extends DGamePlayerEvent implements Cancellab } /** - * @param lostLives - * the lostLives to set + * @param lostLives the lostLives to set */ public void setLostLives(int lostLives) { this.lostLives = lostLives; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerFinishEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerFinishEvent.java index 10780404..fcd73e66 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerFinishEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dplayer/instance/game/DGamePlayerFinishEvent.java @@ -43,8 +43,7 @@ public class DGamePlayerFinishEvent extends DGamePlayerEvent implements Cancella } /** - * @param hasToWait - * the hasToWait to set + * @param hasToWait the hasToWait to set */ public void setHasToWait(boolean hasToWait) { this.hasToWait = hasToWait; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignEvent.java index 363be54f..e1466cd9 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignEvent.java @@ -38,8 +38,7 @@ public abstract class DSignEvent extends Event { } /** - * @param dSign - * the dSign to set + * @param dSign the dSign to set */ public void setDSign(DSign dSign) { this.dSign = dSign; diff --git a/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignRegistrationEvent.java b/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignRegistrationEvent.java index 4f8dec0c..98fe6ad6 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignRegistrationEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/dsign/DSignRegistrationEvent.java @@ -47,8 +47,7 @@ public class DSignRegistrationEvent extends DSignEvent implements Cancellable { } /** - * @param sign - * the sign to set + * @param sign the sign to set */ public void setSign(Sign sign) { this.sign = sign; @@ -62,8 +61,7 @@ public class DSignRegistrationEvent extends DSignEvent implements Cancellable { } /** - * @param gameWorld - * the gameWorld to set + * @param gameWorld the gameWorld to set */ public void setGameWorld(DGameWorld gameWorld) { this.gameWorld = gameWorld; diff --git a/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldEvent.java b/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldEvent.java index 87a90fb1..cabd3caa 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldEvent.java @@ -38,8 +38,7 @@ public abstract class EditWorldEvent extends Event { } /** - * @param editWorld - * the editWorld to set + * @param editWorld the editWorld to set */ public void setEditWorld(DEditWorld editWorld) { this.editWorld = editWorld; diff --git a/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldLoadEvent.java b/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldLoadEvent.java index 98483b6b..e8eed7da 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldLoadEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldLoadEvent.java @@ -42,8 +42,7 @@ public class EditWorldLoadEvent extends Event implements Cancellable { } /** - * @param name - * the name to set + * @param name the name to set */ public void setName(String name) { this.name = name; diff --git a/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldUnloadEvent.java b/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldUnloadEvent.java index 29e28f7e..4491783a 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldUnloadEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/editworld/EditWorldUnloadEvent.java @@ -43,8 +43,7 @@ public class EditWorldUnloadEvent extends EditWorldEvent implements Cancellable } /** - * @param save - * the save to set + * @param save the save to set */ public void setSave(boolean save) { this.save = save; diff --git a/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldEvent.java b/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldEvent.java index a97a3435..5050834a 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldEvent.java @@ -38,8 +38,7 @@ public abstract class GameWorldEvent extends Event { } /** - * @param gameWorld - * the gameWorld to set + * @param gameWorld the gameWorld to set */ public void setGameWorld(DGameWorld gameWorld) { this.gameWorld = gameWorld; diff --git a/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldLoadEvent.java b/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldLoadEvent.java index 58dde4de..e44f3750 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldLoadEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldLoadEvent.java @@ -42,8 +42,7 @@ public class GameWorldLoadEvent extends Event implements Cancellable { } /** - * @param name - * the name to set + * @param name the name to set */ public void setName(String name) { this.name = name; diff --git a/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldStartGameEvent.java b/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldStartGameEvent.java index 7f6ae876..14721545 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldStartGameEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/gameworld/GameWorldStartGameEvent.java @@ -44,8 +44,7 @@ public class GameWorldStartGameEvent extends GameWorldEvent implements Cancellab } /** - * @param game - * the game to set + * @param game the game to set */ public void setGame(Game game) { this.game = game; diff --git a/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementCheckEvent.java b/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementCheckEvent.java index cd341aa7..a58f1bcc 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementCheckEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementCheckEvent.java @@ -44,8 +44,7 @@ public class RequirementCheckEvent extends RequirementEvent implements Cancellab } /** - * @param player - * the player to set + * @param player the player to set */ public void setPlayer(Player player) { this.player = player; diff --git a/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementDemandEvent.java b/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementDemandEvent.java index 859007a8..d33d4f1c 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementDemandEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementDemandEvent.java @@ -44,8 +44,7 @@ public class RequirementDemandEvent extends RequirementEvent implements Cancella } /** - * @param player - * the player to set + * @param player the player to set */ public void setPlayer(Player player) { this.player = player; diff --git a/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementEvent.java b/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementEvent.java index 25bbfed3..16738eeb 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/requirement/RequirementEvent.java @@ -39,8 +39,7 @@ public abstract class RequirementEvent extends Event { } /** - * @param requirement - * the requirement to set + * @param requirement the requirement to set */ public void setRequirement(Requirement requirement) { this.requirement = requirement; diff --git a/src/main/java/de/erethon/dungeonsxl/event/reward/RewardAdditionEvent.java b/src/main/java/de/erethon/dungeonsxl/event/reward/RewardAdditionEvent.java index e788db71..722f2107 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/reward/RewardAdditionEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/reward/RewardAdditionEvent.java @@ -44,8 +44,7 @@ public class RewardAdditionEvent extends RewardEvent implements Cancellable { } /** - * @param dGroup - * the dGroup to set + * @param dGroup the dGroup to set */ public void setDGroup(DGroup dGroup) { this.dGroup = dGroup; diff --git a/src/main/java/de/erethon/dungeonsxl/event/reward/RewardEvent.java b/src/main/java/de/erethon/dungeonsxl/event/reward/RewardEvent.java index 86c61f3b..6cbe99f3 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/reward/RewardEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/reward/RewardEvent.java @@ -38,8 +38,7 @@ public abstract class RewardEvent extends Event { } /** - * @param reward - * the reward to set + * @param reward the reward to set */ public void setReward(Reward reward) { this.reward = reward; diff --git a/src/main/java/de/erethon/dungeonsxl/event/trigger/TriggerRegistrationEvent.java b/src/main/java/de/erethon/dungeonsxl/event/trigger/TriggerRegistrationEvent.java index 7471ed6c..fee6e441 100644 --- a/src/main/java/de/erethon/dungeonsxl/event/trigger/TriggerRegistrationEvent.java +++ b/src/main/java/de/erethon/dungeonsxl/event/trigger/TriggerRegistrationEvent.java @@ -33,8 +33,7 @@ public class TriggerRegistrationEvent extends TriggerEvent implements Cancellabl } /** - * @param trigger - * the trigger to set + * @param trigger the trigger to set */ public void setTrigger(Trigger trigger) { this.trigger = trigger; diff --git a/src/main/java/de/erethon/dungeonsxl/game/Game.java b/src/main/java/de/erethon/dungeonsxl/game/Game.java index a3334821..34a655c4 100644 --- a/src/main/java/de/erethon/dungeonsxl/game/Game.java +++ b/src/main/java/de/erethon/dungeonsxl/game/Game.java @@ -41,15 +41,14 @@ import org.bukkit.entity.Player; import org.bukkit.scheduler.BukkitRunnable; /** - * Game mostly stores for which purposes and how a {@link de.erethon.dungeonsxl.dungeon.Dungeon} is used, - * the player groups and the progress. + * Game mostly stores for which purposes and how a {@link de.erethon.dungeonsxl.dungeon.Dungeon} is used, the player groups and the progress. * * @author Daniel Saukel */ public class Game { DungeonsXL plugin = DungeonsXL.getInstance(); - + private boolean tutorial; private List dGroups = new ArrayList<>(); private boolean started; @@ -135,8 +134,7 @@ public class Game { } /** - * @param tutorial - * if the DGameWorld is the tutorial + * @param tutorial if the DGameWorld is the tutorial */ public void setTutorial(boolean tutorial) { this.tutorial = tutorial; @@ -150,8 +148,7 @@ public class Game { } /** - * @param dGroup - * the dGroups to add + * @param dGroup the dGroups to add */ public void addDGroup(DGroup dGroup) { dGroups.add(dGroup); @@ -162,8 +159,7 @@ public class Game { } /** - * @param dGroup - * the dGroups to remove + * @param dGroup the dGroups to remove */ public void removeDGroup(DGroup dGroup) { dGroups.remove(dGroup); @@ -181,8 +177,7 @@ public class Game { } /** - * @param started - * set if the Game has started yet + * @param started set if the Game has started yet */ public void setStarted(boolean started) { this.started = started; @@ -196,8 +191,7 @@ public class Game { } /** - * @param type - * the type to set + * @param type the type to set */ public void setType(GameType type) { this.type = type; @@ -211,8 +205,7 @@ public class Game { } /** - * @param world - * the DGameWorld to connect to the Game + * @param world the DGameWorld to connect to the Game */ public void setWorld(DGameWorld world) { this.world = world; @@ -226,21 +219,15 @@ public class Game { } /** - * @param rules - * the GameRules to set + * @param rules the GameRules to set */ public void setRules(GameRuleProvider rules) { this.rules = rules; } /** - * Fetchs the rules with the following priority: - * 1. Game type - * 2. Dungeon config: Override values - * 3. Floor config - * 4. Dungeon config: Default values - * 5. Main config: Default values - * 6. The default values + * Fetchs the rules with the following priority: 1. Game type 2. Dungeon config: Override values 3. Floor config 4. Dungeon config: Default values 5. Main + * config: Default values 6. The default values */ public void fetchRules() { DungeonConfig dungeonConfig = null; @@ -316,8 +303,7 @@ public class Game { } /** - * @param waveCount - * the waveCount to set + * @param waveCount the waveCount to set */ public void setWaveCount(int waveCount) { this.waveCount = waveCount; @@ -346,8 +332,7 @@ public class Game { } /** - * @param killer - * the killer; null if the killer is not a player + * @param killer the killer; null if the killer is not a player */ public void addKill(String killer) { if (killer == null) { @@ -406,10 +391,8 @@ public class Game { } /** - * @param mobCountIncreaseRate - * the new mob count will be increased by this rate - * @param teleport - * whether or not to teleport the players to the start location + * @param mobCountIncreaseRate the new mob count will be increased by this rate + * @param teleport whether or not to teleport the players to the start location */ public void finishWave(final double mobCountIncreaseRate, final boolean teleport) { waveCount++; diff --git a/src/main/java/de/erethon/dungeonsxl/game/GameGoal.java b/src/main/java/de/erethon/dungeonsxl/game/GameGoal.java index 09456351..d5710b3c 100644 --- a/src/main/java/de/erethon/dungeonsxl/game/GameGoal.java +++ b/src/main/java/de/erethon/dungeonsxl/game/GameGoal.java @@ -24,13 +24,11 @@ package de.erethon.dungeonsxl.game; public enum GameGoal { /** - * The default goal. - * The game ends when the end is reached. + * The default goal. The game ends when the end is reached. */ END, /** - * The game does not end. - * Instead, the goal is to survive as long as possible to beat a highscore. + * The game does not end. Instead, the goal is to survive as long as possible to beat a highscore. */ HIGHSCORE, /** @@ -42,13 +40,11 @@ public enum GameGoal { */ REACH_SCORE, /** - * The game ends after a specific time. - * The goal is to get the highest score until then. + * The game ends after a specific time. The goal is to get the highest score until then. */ TIME_SCORE, /** - * The game ends after a specific time. - * The goal is to survive until then. + * The game ends after a specific time. The goal is to survive until then. */ TIME_SURVIVAL; diff --git a/src/main/java/de/erethon/dungeonsxl/game/GameRuleProvider.java b/src/main/java/de/erethon/dungeonsxl/game/GameRuleProvider.java index f5c53911..6b639b6b 100644 --- a/src/main/java/de/erethon/dungeonsxl/game/GameRuleProvider.java +++ b/src/main/java/de/erethon/dungeonsxl/game/GameRuleProvider.java @@ -261,50 +261,42 @@ public class GameRuleProvider { } /** - * @return - * if it's raining permanently in this dungeon, - * null if random + * @return if it's raining permanently in this dungeon, null if random */ public Boolean isRaining() { return rain; } /** - * @param rain - * set if it's raining permanently in this dungeon + * @param rain set if it's raining permanently in this dungeon */ public void setRaining(Boolean rain) { this.rain = rain; } /** - * @return - * You've been... THUNDERSTRUCK! + * @return You've been... THUNDERSTRUCK! */ public Boolean isThundering() { return thunder; } /** - * @param thunder - * You've been... THUNDERSTRUCK! + * @param thunder You've been... THUNDERSTRUCK! */ public void setThundering(Boolean thunder) { this.thunder = thunder; } /** - * @return - * the locked day time in this dungeon, - * null if not locked + * @return the locked day time in this dungeon, null if not locked */ public Long getTime() { return time; } /** - * @param time - * the locked day time to set + * @param time the locked day time to set */ public void setTime(Long time) { this.time = time; @@ -432,8 +424,7 @@ public class GameRuleProvider { } /** - * @return all maps needed to be finished to play this map and a collection of maps of which at - * least one has to be finished + * @return all maps needed to be finished to play this map and a collection of maps of which at least one has to be finished */ public List getFinished() { if (finishedAll == null) { @@ -489,8 +480,7 @@ public class GameRuleProvider { } /** - * @param text - * the text to set + * @param text the text to set */ public void setTitle(String text) { title = text; @@ -504,8 +494,7 @@ public class GameRuleProvider { } /** - * @param text - * the text to set + * @param text the text to set */ public void setSubTitle(String text) { subtitle = text; @@ -519,8 +508,7 @@ public class GameRuleProvider { } /** - * @param text - * the text to set + * @param text the text to set */ public void setActionBar(String text) { actionBar = text; @@ -534,8 +522,7 @@ public class GameRuleProvider { } /** - * @param text - * the text to set + * @param text the text to set */ public void setChatText(String text) { chat = text; @@ -549,8 +536,7 @@ public class GameRuleProvider { } /** - * @param time - * the time to set + * @param time the time to set */ public void setTitleFadeIn(int time) { titleFadeIn = time; @@ -564,8 +550,7 @@ public class GameRuleProvider { } /** - * @param time - * the time to set + * @param time the time to set */ public void setTitleFadeOut(int time) { titleFadeOut = time; @@ -579,8 +564,7 @@ public class GameRuleProvider { } /** - * @param time - * the time to set + * @param time the time to set */ public void setTitleShow(int time) { titleShow = time; @@ -588,8 +572,8 @@ public class GameRuleProvider { // Misc /** - * @param id - * the id of the message + * @param id the id of the message + * @return the message */ public String getMessage(int id) { if (msgs == null) { @@ -599,10 +583,8 @@ public class GameRuleProvider { } /** - * @param id - * the ID of the message - * @param msg - * the message to set + * @param id the ID of the message + * @param msg the message to set */ public void setMessage(int id, String msg) { if (msgs == null) { @@ -622,9 +604,7 @@ public class GameRuleProvider { } /** - * @return - * if the group tag is enabled. - * Returns false if HolographicDisplays isn't loaded + * @return if the group tag is enabled. Returns false if HolographicDisplays isn't loaded */ public boolean isGroupTagEnabled() { if (!Bukkit.getPluginManager().isPluginEnabled("HolographicDisplays")) { @@ -635,8 +615,7 @@ public class GameRuleProvider { /* Actions */ /** - * @param defaultValues - * the GameType that overrides the values that are null. + * @param defaultValues the GameType that overrides the values that are null. */ public void apply(GameType defaultValues) { if (playerVersusPlayer == null) { @@ -675,8 +654,7 @@ public class GameRuleProvider { } /** - * @param defaultValues - * the GameRules that override the values that are null. + * @param defaultValues the GameRules that override the values that are null. */ public void apply(GameRuleProvider defaultValues) { /* keepInventory */ diff --git a/src/main/java/de/erethon/dungeonsxl/game/GameType.java b/src/main/java/de/erethon/dungeonsxl/game/GameType.java index 40c77f87..53e48f0f 100644 --- a/src/main/java/de/erethon/dungeonsxl/game/GameType.java +++ b/src/main/java/de/erethon/dungeonsxl/game/GameType.java @@ -31,8 +31,7 @@ public interface GameType { public String getDisplayName(); /** - * @param displayName - * the displayName to set + * @param displayName the displayName to set */ public void setDisplayName(String displayName); @@ -42,8 +41,7 @@ public interface GameType { public String getSignName(); /** - * @param signName - * the signName to set + * @param signName the signName to set */ public void setSignName(String signName); @@ -53,8 +51,7 @@ public interface GameType { public GameGoal getGameGoal(); /** - * @param gameGoal - * the goal of the game to set + * @param gameGoal the goal of the game to set */ public void setGameGoal(GameGoal gameGoal); @@ -64,8 +61,7 @@ public interface GameType { public Boolean isPlayerVersusPlayer(); /** - * @param playerVersusPlayer - * the playerVersusPlayer to set + * @param playerVersusPlayer the playerVersusPlayer to set */ public void setPlayerVersusPlayer(Boolean playerVersusPlayer); @@ -75,8 +71,7 @@ public interface GameType { public Boolean isFriendlyFire(); /** - * @param friendlyFire - * the friendlyFire to set + * @param friendlyFire the friendlyFire to set */ public void setFriendlyFire(Boolean friendlyFire); @@ -86,8 +81,7 @@ public interface GameType { public Boolean hasRewards(); /** - * @param rewards - * enable / disable rewards + * @param rewards enable / disable rewards */ public void setRewards(Boolean rewards); @@ -97,8 +91,7 @@ public interface GameType { public Boolean getShowTime(); /** - * @param showTime - * set if players shall see how long they play + * @param showTime set if players shall see how long they play */ public void setShowTime(Boolean showTime); @@ -108,8 +101,7 @@ public interface GameType { public Boolean canBreakBlocks(); /** - * @param breakBlocks - * if blocks may be destroyed + * @param breakBlocks if blocks may be destroyed */ public void setBreakBlocks(Boolean breakBlocks); @@ -119,8 +111,7 @@ public interface GameType { public Boolean canBreakPlacedBlocks(); /** - * @param breakPlacedBlocks - * if placed blocks may be destroyed + * @param breakPlacedBlocks if placed blocks may be destroyed */ public void setBreakPlacedBlocks(Boolean breakPlacedBlocks); @@ -130,8 +121,7 @@ public interface GameType { public Boolean canPlaceBlocks(); /** - * @param placeBlocks - * if blocks may be placed + * @param placeBlocks if blocks may be placed */ public void setPlaceBlocks(Boolean placeBlocks); @@ -141,8 +131,7 @@ public interface GameType { public GameMode getGameMode(); /** - * @param gameMode - * the gameMode to set + * @param gameMode the gameMode to set */ public void setGameMode(GameMode gameMode); @@ -152,8 +141,7 @@ public interface GameType { public Boolean hasLives(); /** - * @param lives - * set if the gametype uses player lives + * @param lives set if the gametype uses player lives */ public void setLives(Boolean lives); diff --git a/src/main/java/de/erethon/dungeonsxl/game/GameTypeCache.java b/src/main/java/de/erethon/dungeonsxl/game/GameTypeCache.java index 0cdeae88..af75e67e 100644 --- a/src/main/java/de/erethon/dungeonsxl/game/GameTypeCache.java +++ b/src/main/java/de/erethon/dungeonsxl/game/GameTypeCache.java @@ -47,6 +47,7 @@ public class GameTypeCache { } /** + * @param name the name to check * @return the game type which has the enum value name */ public GameType getByName(String name) { @@ -60,6 +61,7 @@ public class GameTypeCache { } /** + * @param sign the sign to check * @return the game type which has the enum value sign text in the second line of the sign */ public GameType getBySign(DSign sign) { @@ -82,16 +84,14 @@ public class GameTypeCache { } /** - * @param type - * the game type to add + * @param type the game type to add */ public void addGameType(GameType type) { types.add(type); } /** - * @param game - * the game to remove + * @param type the game type to remove */ public void removeGameType(GameType type) { types.remove(type); diff --git a/src/main/java/de/erethon/dungeonsxl/global/DPortal.java b/src/main/java/de/erethon/dungeonsxl/global/DPortal.java index ccbb32f5..da95b1f5 100644 --- a/src/main/java/de/erethon/dungeonsxl/global/DPortal.java +++ b/src/main/java/de/erethon/dungeonsxl/global/DPortal.java @@ -81,8 +81,7 @@ public class DPortal extends GlobalProtection { } /** - * @param block1 - * the block1 to set + * @param block1 the block1 to set */ public void setBlock1(Block block1) { this.block1 = block1; @@ -96,8 +95,7 @@ public class DPortal extends GlobalProtection { } /** - * @param block2 - * the block2 to set + * @param block2 the block2 to set */ public void setBlock2(Block block2) { this.block2 = block2; @@ -111,8 +109,7 @@ public class DPortal extends GlobalProtection { } /** - * @param active - * set the DPortal active + * @param active set the DPortal active */ public void setActive(boolean active) { this.active = active; @@ -120,6 +117,8 @@ public class DPortal extends GlobalProtection { /** * Create a new DPortal + * + * @param player the creator */ public void create(DGlobalPlayer player) { if (block1 == null || block2 == null) { @@ -188,8 +187,7 @@ public class DPortal extends GlobalProtection { } /** - * @param player - * the player to teleport into his dungeon + * @param player the player to teleport into his dungeon */ public void teleport(Player player) { DGroup dGroup = DGroup.getByPlayer(player); @@ -330,16 +328,16 @@ public class DPortal extends GlobalProtection { /* Statics */ /** - * @param location - * a location covered by the returned portal + * @param location a location covered by the returned portal + * @return the portal at the location, null if there is none */ public static DPortal getByLocation(Location location) { return getByBlock(location.getBlock()); } /** - * @param block - * a block covered by the returned portal + * @param block a block covered by the returned portal + * @return the portal that the block belongs to, null if it belongs to none */ public static DPortal getByBlock(Block block) { for (GlobalProtection protection : DungeonsXL.getInstance().getGlobalProtections().getProtections(DPortal.class)) { diff --git a/src/main/java/de/erethon/dungeonsxl/global/GameSign.java b/src/main/java/de/erethon/dungeonsxl/global/GameSign.java index 45812f67..6eddb002 100644 --- a/src/main/java/de/erethon/dungeonsxl/global/GameSign.java +++ b/src/main/java/de/erethon/dungeonsxl/global/GameSign.java @@ -50,16 +50,14 @@ public class GameSign extends JoinSign { } /** - * @return - * the attached game + * @return the attached game */ public Game getGame() { return game; } /** - * @param game - * the game to set + * @param game the game to set */ public void setGame(Game game) { this.game = game; @@ -172,8 +170,8 @@ public class GameSign extends JoinSign { /* Statics */ /** - * @param block - * a block which is protected by the returned GameSign + * @param block a block which is protected by the returned GameSign + * @return the game sign the block belongs to, null if it belongs to none */ public static GameSign getByBlock(Block block) { if (!Category.SIGNS.containsBlock(block)) { @@ -192,8 +190,8 @@ public class GameSign extends JoinSign { } /** - * @param game - * the game to check + * @param game the game to check + * @return the game that this sign creates */ public static GameSign getByGame(Game game) { for (GlobalProtection protection : DungeonsXL.getInstance().getGlobalProtections().getProtections(GameSign.class)) { diff --git a/src/main/java/de/erethon/dungeonsxl/global/GlobalProtection.java b/src/main/java/de/erethon/dungeonsxl/global/GlobalProtection.java index 304013e7..3f302020 100644 --- a/src/main/java/de/erethon/dungeonsxl/global/GlobalProtection.java +++ b/src/main/java/de/erethon/dungeonsxl/global/GlobalProtection.java @@ -55,8 +55,7 @@ public abstract class GlobalProtection { } /** - * @param world - * the world to set + * @param world the world to set */ public void setWorld(World world) { this.world = world; @@ -85,8 +84,7 @@ public abstract class GlobalProtection { } /** - * @param file - * the file to save the protection to + * @param file the file to save the protection to */ public void save(File file) { save(YamlConfiguration.loadConfiguration(file)); @@ -107,8 +105,7 @@ public abstract class GlobalProtection { /* Abstracts */ /** - * @param config - * the config to save the protection to + * @param config the config to save the protection to */ public abstract void save(FileConfiguration config); diff --git a/src/main/java/de/erethon/dungeonsxl/global/GlobalProtectionCache.java b/src/main/java/de/erethon/dungeonsxl/global/GlobalProtectionCache.java index 33599821..893058a0 100644 --- a/src/main/java/de/erethon/dungeonsxl/global/GlobalProtectionCache.java +++ b/src/main/java/de/erethon/dungeonsxl/global/GlobalProtectionCache.java @@ -45,6 +45,7 @@ public class GlobalProtectionCache { } /** + * @param location the location to check * @return the protection which covers this location */ public GlobalProtection getByLocation(Location location) { @@ -52,6 +53,7 @@ public class GlobalProtectionCache { } /** + * @param block the block to check * @return the protection which covers this block */ public GlobalProtection getByBlock(Block block) { @@ -72,8 +74,8 @@ public class GlobalProtectionCache { } /** - * @param type - * All protections which are an instance of it will be returned. + * @param type All protections which are an instance of it will be returned. + * @return the protections of the type */ public Set getProtections(Class type) { Set protectionsOfType = new HashSet<>(); @@ -86,16 +88,14 @@ public class GlobalProtectionCache { } /** - * @param protection - * the protection type to add + * @param protection the protection type to add */ public void addProtection(GlobalProtection protection) { protections.add(protection); } /** - * @param protection - * the protection to remove + * @param protection the protection to remove */ public void removeProtection(GlobalProtection protection) { protections.remove(protection); @@ -109,16 +109,14 @@ public class GlobalProtectionCache { } /** - * @param file - * the file to save all protections to + * @param file the file to save all protections to */ public void saveAll(File file) { saveAll(YamlConfiguration.loadConfiguration(file)); } /** - * @param config - * the config to save all protections to + * @param config the config to save all protections to */ public void saveAll(FileConfiguration config) { config.set("protections", null); @@ -130,10 +128,8 @@ public class GlobalProtectionCache { } /** - * @param type - * Each type is stored seperately. - * @param world - * Each world has its own IDs. + * @param type Each type is stored seperately. + * @param world Each world has its own IDs. * @return an unused ID number for a new protection */ public int generateId(Class type, World world) { @@ -147,8 +143,8 @@ public class GlobalProtectionCache { } /** - * @param block - * the block to check + * @param block the block to check + * @return if the block is protected by a GlobalProtection */ public boolean isProtectedBlock(Block block) { for (GlobalProtection protection : protections) { diff --git a/src/main/java/de/erethon/dungeonsxl/global/GroupSign.java b/src/main/java/de/erethon/dungeonsxl/global/GroupSign.java index b861305e..1ec3d8e1 100644 --- a/src/main/java/de/erethon/dungeonsxl/global/GroupSign.java +++ b/src/main/java/de/erethon/dungeonsxl/global/GroupSign.java @@ -51,16 +51,14 @@ public class GroupSign extends JoinSign { } /** - * @return - * the attached group + * @return the attached group */ public DGroup getGroup() { return group; } /** - * @param group - * the group to set + * @param group the group to set */ public void setGroup(DGroup group) { this.group = group; @@ -162,8 +160,8 @@ public class GroupSign extends JoinSign { /* Statics */ /** - * @param block - * a block which is protected by the returned GroupSign + * @param block a block which is protected by the returned GroupSign + * @return the group sign the block belongs to, null if it belongs to none */ public static GroupSign getByBlock(Block block) { if (!Category.SIGNS.containsBlock(block)) { diff --git a/src/main/java/de/erethon/dungeonsxl/global/JoinSign.java b/src/main/java/de/erethon/dungeonsxl/global/JoinSign.java index 0f6145db..2d94ade7 100644 --- a/src/main/java/de/erethon/dungeonsxl/global/JoinSign.java +++ b/src/main/java/de/erethon/dungeonsxl/global/JoinSign.java @@ -57,32 +57,28 @@ public class JoinSign extends GlobalProtection { } /** - * @return - * the dungeon + * @return the dungeon */ public Dungeon getDungeon() { return dungeon; } /** - * @param dungeon - * the dungeon to set + * @param dungeon the dungeon to set */ public void setDungeon(Dungeon dungeon) { this.dungeon = dungeon; } /** - * @return - * the maximum element count per sign + * @return the maximum element count per sign */ public int getMaxElements() { return maxElements; } /** - * @param maxElements - * the maximum element count per sign + * @param maxElements the maximum element count per sign */ public void setMaxElements(int maxElements) { this.maxElements = maxElements; diff --git a/src/main/java/de/erethon/dungeonsxl/global/LeaveSign.java b/src/main/java/de/erethon/dungeonsxl/global/LeaveSign.java index d04eaf1b..fe003773 100644 --- a/src/main/java/de/erethon/dungeonsxl/global/LeaveSign.java +++ b/src/main/java/de/erethon/dungeonsxl/global/LeaveSign.java @@ -99,8 +99,8 @@ public class LeaveSign extends GlobalProtection { /* Statics */ /** - * @param block - * a block which is protected by the returned LeaveSign + * @param block a block which is protected by the returned LeaveSign + * @return the leave sign the block belongs to, null if it belongs to none */ public static LeaveSign getByBlock(Block block) { for (GlobalProtection protection : DungeonsXL.getInstance().getGlobalProtections().getProtections(LeaveSign.class)) { diff --git a/src/main/java/de/erethon/dungeonsxl/mob/CitizensMobProvider.java b/src/main/java/de/erethon/dungeonsxl/mob/CitizensMobProvider.java index 2ecebb03..8c8dee3e 100644 --- a/src/main/java/de/erethon/dungeonsxl/mob/CitizensMobProvider.java +++ b/src/main/java/de/erethon/dungeonsxl/mob/CitizensMobProvider.java @@ -55,16 +55,14 @@ public class CitizensMobProvider implements ExternalMobProvider, Listener { } /** - * @param npc - * the NPC to add + * @param npc the NPC to add */ public void addSpawnedNPC(NPC npc) { spawnedNPCs.add(npc); } /** - * @param npc - * the NPC to remove + * @param npc the NPC to remove */ public void removeSpawnedNPC(NPC npc) { spawnedNPCs.remove(npc); diff --git a/src/main/java/de/erethon/dungeonsxl/mob/DMobType.java b/src/main/java/de/erethon/dungeonsxl/mob/DMobType.java index 8ccb0183..49a3da1b 100644 --- a/src/main/java/de/erethon/dungeonsxl/mob/DMobType.java +++ b/src/main/java/de/erethon/dungeonsxl/mob/DMobType.java @@ -70,18 +70,15 @@ public class DMobType extends ExMob { private String ocelotType = null; /** - * @param file - * the script file + * @param file the script file */ public DMobType(File file) { this(file.getName().substring(0, file.getName().length() - 4), YamlConfiguration.loadConfiguration(file)); } /** - * @param name - * the name of the DMobType - * @param config - * the config that stores the information + * @param name the name of the DMobType + * @param config the config that stores the information */ public DMobType(String name, FileConfiguration config) { this.name = name; @@ -190,10 +187,8 @@ public class DMobType extends ExMob { } /** - * @param name - * the name of the DMobType - * @param type - * the EntityType of the mob + * @param name the name of the DMobType + * @param type the EntityType of the mob */ public DMobType(String name, EntityType type) { this.name = name; @@ -209,8 +204,7 @@ public class DMobType extends ExMob { } /** - * @param name - * the name to set + * @param name the name to set */ public void setName(String name) { this.name = name; @@ -224,8 +218,7 @@ public class DMobType extends ExMob { } /** - * @param type - * the type to set + * @param type the type to set */ public void setType(EntityType type) { this.type = type; @@ -239,8 +232,7 @@ public class DMobType extends ExMob { } /** - * @param maxHealth - * the maxHealth to set + * @param maxHealth the maxHealth to set */ public void setMaxHealth(int maxHealth) { this.maxHealth = maxHealth; @@ -254,8 +246,7 @@ public class DMobType extends ExMob { } /** - * @param itemHand - * the itemHand to set + * @param itemHand the itemHand to set */ public void setitemHand(ItemStack itemHand) { this.itemHand = itemHand; @@ -269,8 +260,7 @@ public class DMobType extends ExMob { } /** - * @param itemHelmet - * the itemHelmet to set + * @param itemHelmet the itemHelmet to set */ public void setitemHelmet(ItemStack itemHelmet) { this.itemHelmet = itemHelmet; @@ -284,8 +274,7 @@ public class DMobType extends ExMob { } /** - * @param itemChestplate - * the itemChestplate to set + * @param itemChestplate the itemChestplate to set */ public void setitemChestplate(ItemStack itemChestplate) { this.itemChestplate = itemChestplate; @@ -299,8 +288,7 @@ public class DMobType extends ExMob { } /** - * @param itemLeggings - * the itemLeggings to set + * @param itemLeggings the itemLeggings to set */ public void setitemLeggings(ItemStack itemLeggings) { this.itemLeggings = itemLeggings; @@ -314,8 +302,7 @@ public class DMobType extends ExMob { } /** - * @param itemBoots - * the itemBoots to set + * @param itemBoots the itemBoots to set */ public void setitemBoots(ItemStack itemBoots) { this.itemBoots = itemBoots; @@ -329,8 +316,7 @@ public class DMobType extends ExMob { } /** - * @param drops - * the drops to set + * @param drops the drops to set */ public void setDrops(Map drops) { this.drops = drops; @@ -344,8 +330,7 @@ public class DMobType extends ExMob { } /** - * @param witherSkeleton - * set if the skeleton is a wither skeleton + * @param witherSkeleton set if the skeleton is a wither skeleton */ public void setWitherSkeleton(boolean witherSkeleton) { this.witherSkeleton = witherSkeleton; @@ -359,8 +344,7 @@ public class DMobType extends ExMob { } /** - * @param ocelotType - * the ocelotType to set + * @param ocelotType the ocelotType to set */ public void setOcelotType(String ocelotType) { this.ocelotType = ocelotType; diff --git a/src/main/java/de/erethon/dungeonsxl/mob/DNPCRegistry.java b/src/main/java/de/erethon/dungeonsxl/mob/DNPCRegistry.java index f599331a..1cfc25c1 100644 --- a/src/main/java/de/erethon/dungeonsxl/mob/DNPCRegistry.java +++ b/src/main/java/de/erethon/dungeonsxl/mob/DNPCRegistry.java @@ -125,10 +125,8 @@ public class DNPCRegistry implements NPCRegistry { /** * Clones an NPC without spamming the config. * - * @param npc - * the NPC to clone - * @return - * a clone of the NPC + * @param npc the NPC to clone + * @return a clone of the NPC */ public NPC createTransientClone(AbstractNPC npc) { NPC copy = createNPC(npc.getTrait(MobType.class).getType(), npc.getFullName()); diff --git a/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProvider.java b/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProvider.java index 6baacf5d..f371cb26 100644 --- a/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProvider.java +++ b/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProvider.java @@ -36,25 +36,18 @@ public interface ExternalMobProvider { public String getRawCommand(); /** - * @param mob - * the mob identifier - * @param world - * the game world - * @param x - * the x coordinate - * @param y - * the y coordinate - * @param z - * the z coordinate + * @param mob the mob identifier + * @param world the game world + * @param x the x coordinate + * @param y the y coordinate + * @param z the z coordinate * @return the command with replaced variables */ public String getCommand(String mob, String world, double x, double y, double z); /** - * @param mob - * the mob identifier - * @param location - * the location where the mob will be spawned + * @param mob the mob identifier + * @param location the location where the mob will be spawned */ public void summon(String mob, Location location); diff --git a/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProviderCache.java b/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProviderCache.java index cd6fd07d..70495068 100644 --- a/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProviderCache.java +++ b/src/main/java/de/erethon/dungeonsxl/mob/ExternalMobProviderCache.java @@ -53,8 +53,8 @@ public class ExternalMobProviderCache { } /** - * @param identifier - * the identifier for ExternalMob signs + * @param identifier the identifier to check + * @return the ExternalMobProvider represented by the identifier */ public ExternalMobProvider getByIdentifier(String identifier) { for (ExternalMobProvider provider : providers) { @@ -87,16 +87,14 @@ public class ExternalMobProviderCache { } /** - * @param provider - * the provider to register + * @param provider the provider to register */ public void addExternalMobProvider(ExternalMobProvider provider) { providers.add(provider); } /** - * @param provider - * the provider to unregister + * @param provider the provider to unregister */ public void removeExternalMobProvider(ExternalMobProvider provider) { providers.remove(provider); diff --git a/src/main/java/de/erethon/dungeonsxl/player/DClass.java b/src/main/java/de/erethon/dungeonsxl/player/DClass.java index a1bb0498..e144600a 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DClass.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DClass.java @@ -77,16 +77,14 @@ public class DClass { } /** - * @param itemStack - * the ItemStack to add + * @param itemStack the ItemStack to add */ public void addItem(ItemStack itemStack) { items.add(itemStack); } /** - * @param itemStack - * the ItemStack to remove + * @param itemStack the ItemStack to remove */ public void removeItem(ItemStack itemStack) { items.remove(itemStack); @@ -100,8 +98,7 @@ public class DClass { } /** - * @param dog - * set if the class has a dog + * @param dog set if the class has a dog */ public void setDog(boolean dog) { this.dog = dog; diff --git a/src/main/java/de/erethon/dungeonsxl/player/DClassCache.java b/src/main/java/de/erethon/dungeonsxl/player/DClassCache.java index 3774f37b..4e4fb739 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DClassCache.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DClassCache.java @@ -39,6 +39,7 @@ public class DClassCache { } /** + * @param name the name to check * @return the dClass that has the name */ public DClass getByName(String name) { @@ -59,16 +60,14 @@ public class DClassCache { } /** - * @param dClass - * the DClass to add + * @param dClass the DClass to add */ public void addDClass(DClass dClass) { dClasses.add(dClass); } /** - * @param dClass - * the DClass to remove + * @param dClass the DClass to remove */ public void removeDClass(DClass dClass) { dClasses.remove(dClass); diff --git a/src/main/java/de/erethon/dungeonsxl/player/DEditPlayer.java b/src/main/java/de/erethon/dungeonsxl/player/DEditPlayer.java index 51c663d3..0dd5edf5 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DEditPlayer.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DEditPlayer.java @@ -73,10 +73,8 @@ public class DEditPlayer extends DInstancePlayer { } /** - * @param player - * the represented Player - * @param editWorld - * the player's EditWorld + * @param player the represented Player + * @param editWorld the player's EditWorld */ public static void create(Player player, DEditWorld editWorld) { new CreateDInstancePlayerTask(player, editWorld).runTaskTimer(DungeonsXL.getInstance(), 0L, 5L); @@ -91,8 +89,7 @@ public class DEditPlayer extends DInstancePlayer { } /** - * @param linesCopy - * the linesCopy to set + * @param linesCopy the linesCopy to set */ public void setLinesCopy(String[] linesCopy) { this.linesCopy = linesCopy; diff --git a/src/main/java/de/erethon/dungeonsxl/player/DGamePlayer.java b/src/main/java/de/erethon/dungeonsxl/player/DGamePlayer.java index 3cadcb2a..284195bc 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DGamePlayer.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DGamePlayer.java @@ -112,23 +112,17 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param player - * the represented Player - * @param gameWorld - * the player's GameWorld + * @param player the represented Player + * @param gameWorld the player's GameWorld */ public static void create(Player player, DGameWorld gameWorld) { create(player, gameWorld, null); } /** - * @param player - * the represented Player - * @param gameWorld - * the player's GameWorld - * @param ready - * Any GameType if the player will be ready from the beginning - * null if the player will not be ready from the beginning + * @param player the represented Player + * @param gameWorld the player's GameWorld + * @param ready Any GameType if the player will be ready from the beginning null if the player will not be ready from the beginning */ public static void create(Player player, DGameWorld gameWorld, GameType ready) { new CreateDInstancePlayerTask(player, gameWorld, ready).runTaskTimer(DungeonsXL.getInstance(), 0L, 5L); @@ -155,8 +149,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param player - * the player to set + * @param player the player to set */ public void setPlayer(Player player) { this.player = player; @@ -196,8 +189,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param ready - * If the player is ready to play the dungeon + * @param ready If the player is ready to play the dungeon */ public void setReady(boolean ready) { this.ready = ready; @@ -211,8 +203,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param finished - * the finished to set + * @param finished the finished to set */ public void setFinished(boolean finished) { this.finished = finished; @@ -226,8 +217,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param dClass - * the dClass to set + * @param className the name of the class to set */ public void setDClass(String className) { Game game = Game.getByWorld(getPlayer().getWorld()); @@ -303,8 +293,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param checkpoint - * the checkpoint to set + * @param checkpoint the checkpoint to set */ public void setCheckpoint(Location checkpoint) { this.checkpoint = checkpoint; @@ -318,8 +307,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param wolf - * the wolf to set + * @param wolf the wolf to set */ public void setWolf(Wolf wolf) { this.wolf = wolf; @@ -333,8 +321,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param wolfRespawnTime - * the wolfRespawnTime to set + * @param wolfRespawnTime the wolfRespawnTime to set */ public void setWolfRespawnTime(int wolfRespawnTime) { this.wolfRespawnTime = wolfRespawnTime; @@ -348,8 +335,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param offlineTime - * the offlineTime to set + * @param offlineTime the offlineTime to set */ public void setOfflineTime(long offlineTime) { this.offlineTime = offlineTime; @@ -363,8 +349,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param initialLives - * the initialLives to set + * @param initialLives the initialLives to set */ public void setInitialLives(int initialLives) { this.initialLives = initialLives; @@ -378,8 +363,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param lives - * the lives to set + * @param lives the lives to set */ public void setLives(int lives) { this.lives = lives; @@ -400,8 +384,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param dGroup - * the group whose flag is stolen + * @param dGroup the group whose flag is stolen */ public void setRobbedGroup(DGroup dGroup) { if (dGroup != null) { @@ -413,16 +396,14 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @return - * the player's group tag + * @return the player's group tag */ public DGroupTag getDGroupTag() { return groupTag; } /** - * @return - * the player's group tag + * Creates a new group tag for the player. */ public void initDGroupTag() { groupTag = new DGroupTag(this); @@ -470,8 +451,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param message - * if messages should be sent + * @param message if messages should be sent */ public void leave(boolean message) { Game game = Game.getByWorld(getWorld()); @@ -761,8 +741,7 @@ public class DGamePlayer extends DInstancePlayer { /** * The DGamePlayer finishs the current floor. * - * @param specifiedFloor - * the name of the next floor + * @param specifiedFloor the name of the next floor */ public void finishFloor(DResourceWorld specifiedFloor) { if (!dGroup.getDungeon().isMultiFloor()) { @@ -803,8 +782,7 @@ public class DGamePlayer extends DInstancePlayer { } /** - * @param message - * if messages should be sent + * @param message if messages should be sent */ public void finish(boolean message) { if (message) { diff --git a/src/main/java/de/erethon/dungeonsxl/player/DGlobalPlayer.java b/src/main/java/de/erethon/dungeonsxl/player/DGlobalPlayer.java index 93c6485d..95627f88 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DGlobalPlayer.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DGlobalPlayer.java @@ -116,6 +116,8 @@ public class DGlobalPlayer implements PlayerWrapper { /** * Load / reload a new instance of DPlayerData + * + * @param file the file to load from */ public void loadPlayerData(File file) { data = new DPlayerData(file); @@ -129,8 +131,7 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param breakMode - * sets if the player is in break mode + * @param breakMode sets if the player is in break mode */ public void setInBreakMode(boolean breakMode) { this.breakMode = breakMode; @@ -147,8 +148,7 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param groupChat - * set if the player is in group chat + * @param groupChat set if the player is in group chat */ public void setInGroupChat(boolean groupChat) { this.groupChat = groupChat; @@ -165,8 +165,7 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param chatSpyMode - * sets if the player is in chat spy mode + * @param chatSpyMode sets if the player is in chat spy mode */ public void setInChatSpyMode(boolean chatSpyMode) { this.chatSpyMode = chatSpyMode; @@ -187,8 +186,7 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param dPortal - * the portal to create + * @param dPortal the portal to create */ public void setCreatingPortal(DPortal dPortal) { creatingPortal = dPortal; @@ -202,8 +200,7 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param item - * the cached item to set + * @param item the cached item to set */ public void setCachedItem(ItemStack item) { cachedItem = item; @@ -217,8 +214,7 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param enabled - * set if the players receives announcer messages + * @param enabled set if the players receives announcer messages */ public void setAnnouncerEnabled(boolean enabled) { announcerEnabled = enabled; @@ -232,8 +228,7 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param respawnInventory - * the respawnInventory to set + * @param respawnInventory the respawnInventory to set */ public void setRespawnInventory(ItemStack[] respawnInventory) { this.respawnInventory = respawnInventory; @@ -261,16 +256,14 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param respawnArmor - * the respawnArmor to set + * @param respawnArmor the respawnArmor to set */ public void setRespawnArmor(ItemStack[] respawnArmor) { this.respawnArmor = respawnArmor; } /** - * @param permission - * the permission to check + * @param permission the permission to check * @return if the player has the permission */ public boolean hasPermission(DPermission permission) { @@ -292,16 +285,14 @@ public class DGlobalPlayer implements PlayerWrapper { } /** - * @param rewardItems - * the reward items to set + * @param rewardItems the reward items to set */ public void setRewardItems(List rewardItems) { this.rewardItems = rewardItems; } /** - * @param permission - * the permission to check + * @param permission the permission to check * @return if the player has the permission */ public boolean hasPermission(String permission) { @@ -312,8 +303,7 @@ public class DGlobalPlayer implements PlayerWrapper { /** * Sends a message to the player * - * @param message - * the message to send + * @param message the message to send */ public void sendMessage(String message) { MessageUtil.sendMessage(player, message); @@ -321,6 +311,8 @@ public class DGlobalPlayer implements PlayerWrapper { /** * Respawns the player at his old position before he was in a dungeon + * + * @param keepInventory if the inventory shall be reset */ public void reset(boolean keepInventory) { final Location tpLoc = data.getOldLocation().getWorld() != null ? data.getOldLocation() : Bukkit.getWorlds().get(0).getSpawnLocation(); diff --git a/src/main/java/de/erethon/dungeonsxl/player/DGroup.java b/src/main/java/de/erethon/dungeonsxl/player/DGroup.java index 8adca81e..9c6407f1 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DGroup.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DGroup.java @@ -185,16 +185,14 @@ public class DGroup { } /** - * @param name - * the name to set + * @param name the name to set */ public void setName(String name) { this.name = name; } /** - * @param name - * the name to set + * @param color the color to fetch the name from */ public void setName(DColor color) { name = color.toString().replace("_", " "); @@ -208,8 +206,7 @@ public class DGroup { } /** - * @param captain - * the captain to set + * @param captain the captain to set */ public void setCaptain(Player captain) { this.captain = captain; @@ -223,7 +220,7 @@ public class DGroup { } /** - * @return the players as a Set + * @return the players as a Set<DGlobalPlayer> */ public Set getDGlobalPlayers() { Set players = new HashSet<>(); @@ -234,7 +231,7 @@ public class DGroup { } /** - * @return the players as a Set + * @return the players as a Set<DGamePlayer> */ public Set getDGamePlayers() { Set players = new HashSet<>(); @@ -250,18 +247,15 @@ public class DGroup { /** * Sends messages by default. * - * @param player - * the player to add + * @param player the player to add */ public void addPlayer(Player player) { addPlayer(player, true); } /** - * @param player - * the player to add - * @param message - * if messages should be sent + * @param player the player to add + * @param message if messages should be sent */ public void addPlayer(Player player, boolean message) { DPlayerJoinDGroupEvent event = new DPlayerJoinDGroupEvent(DGamePlayer.getByPlayer(player), false, this); @@ -280,18 +274,15 @@ public class DGroup { /** * Sends messages by default. * - * @param player - * the player to remove + * @param player the player to remove */ public void removePlayer(Player player) { removePlayer(player, true); } /** - * @param player - * the player to remove - * @param message - * if messages should be sent + * @param player the player to remove + * @param message if messages should be sent */ public void removePlayer(Player player, boolean message) { players.remove(player.getUniqueId()); @@ -319,8 +310,8 @@ public class DGroup { } /** - * @param player - * the player to add + * @param player the player to add + * @param silent if messages shall be sent */ public void addInvitedPlayer(Player player, boolean silent) { if (player == null) { @@ -348,8 +339,8 @@ public class DGroup { } /** - * @param player - * the player to remove + * @param player the player to remove + * @param silent if messages shall be sent */ public void removeInvitedPlayer(Player player, boolean silent) { if (player == null) { @@ -398,8 +389,7 @@ public class DGroup { } /** - * @param gameWorld - * the gameWorld to set + * @param gameWorld the gameWorld to set */ public void setGameWorld(DGameWorld gameWorld) { this.gameWorld = gameWorld; @@ -415,8 +405,7 @@ public class DGroup { /** * Sets up all dungeon-related fields. * - * @param dungeon - * the dungeon to set + * @param dungeon the dungeon to set */ public void setDungeon(Dungeon dungeon) { this.dungeon = dungeon; @@ -428,8 +417,8 @@ public class DGroup { /** * Sets up all dungeon-related fields. * - * @param name - * the name of the dungeon + * @param name the name of the dungeon + * @return if the action was successful */ public boolean setDungeon(String name) { dungeon = plugin.getDungeons().getByName(name); @@ -472,18 +461,15 @@ public class DGroup { } /** - * @param unplayedFloor - * the unplayed floor to add + * @param unplayedFloor the unplayed floor to add */ public void addUnplayedFloor(DResourceWorld unplayedFloor) { unplayedFloors.add(unplayedFloor); } /** - * @param unplayedFloor - * the unplayed floor to remove - * @param force - * remove the floor even if removeWhenPlayed is disabled + * @param unplayedFloor the unplayed floor to remove + * @param force remove the floor even if removeWhenPlayed is disabled */ public void removeUnplayedFloor(DResourceWorld unplayedFloor, boolean force) { if (getDungeon().getConfig().getRemoveWhenPlayed() || force) { @@ -499,8 +485,7 @@ public class DGroup { } /** - * @param playing - * set if the group is playing + * @param playing set if the group is playing */ public void setPlaying(boolean playing) { this.playing = playing; @@ -514,8 +499,7 @@ public class DGroup { } /** - * @param floorCount - * the floorCount to set + * @param floorCount the floorCount to set */ public void setFloorCount(int floorCount) { this.floorCount = floorCount; @@ -529,8 +513,7 @@ public class DGroup { } /** - * @param reward - * the rewards to add + * @param reward the rewards to add */ public void addReward(Reward reward) { RewardAdditionEvent event = new RewardAdditionEvent(reward, this); @@ -544,8 +527,7 @@ public class DGroup { } /** - * @param reward - * the rewards to remove + * @param reward the rewards to remove */ public void removeReward(Reward reward) { rewards.remove(reward); @@ -559,8 +541,7 @@ public class DGroup { } /** - * @param task - * the task to set + * @param task the task to set */ public void setTimeIsRunningTask(BukkitTask task) { this.timeIsRunningTask = task; @@ -588,8 +569,7 @@ public class DGroup { } /** - * @param floor - * the next floor to set + * @param floor the next floor to set */ public void setNextFloor(DResourceWorld floor) { nextFloor = floor; @@ -621,8 +601,7 @@ public class DGroup { } /** - * @param score - * the score to set + * @param score the score to set */ public void setScore(int score) { this.score = score; @@ -636,8 +615,7 @@ public class DGroup { } /** - * @param initialLives - * the initial group lives to set + * @param initialLives the initial group lives to set */ public void setInitialLives(int initialLives) { this.initialLives = initialLives; @@ -651,8 +629,7 @@ public class DGroup { } /** - * @param lives - * the group lives to set + * @param lives the group lives to set */ public void setLives(int lives) { this.lives = lives; @@ -697,8 +674,7 @@ public class DGroup { /** * The group finishs the current floor. * - * @param specifiedFloor - * the name of the next floor + * @param specifiedFloor the name of the next floor */ public void finishFloor(DResourceWorld specifiedFloor) { DungeonConfig dConfig = dungeon.getConfig(); @@ -924,7 +900,9 @@ public class DGroup { } /** - * Send a message to all players in the group + * Sends a message to all players in the group. + * + * @param message the message to send */ public void sendMessage(String message) { for (Player player : players.getOnlinePlayers()) { @@ -935,10 +913,10 @@ public class DGroup { } /** - * Send a message to all players in the group + * Sends a message to all players in the group. * - * @param except - * Players who do not receive the message + * @param message the message to sent + * @param except Players who shall not receive the message */ public void sendMessage(String message, Player... except) { HashSet exceptSet = new HashSet<>(Arrays.asList(except)); @@ -979,8 +957,7 @@ public class DGroup { } /** - * @param gameWorld - * the DGameWorld to check + * @param gameWorld the DGameWorld to check * @return a List of DGroups in this DGameWorld */ public static List getByGameWorld(DGameWorld gameWorld) { diff --git a/src/main/java/de/erethon/dungeonsxl/player/DInstancePlayer.java b/src/main/java/de/erethon/dungeonsxl/player/DInstancePlayer.java index 5eb74353..784fef0f 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DInstancePlayer.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DInstancePlayer.java @@ -42,16 +42,14 @@ public abstract class DInstancePlayer extends DGlobalPlayer { /* Getters and setters */ /** - * @return - * the instance + * @return the instance */ public World getWorld() { return world; } /** - * @param world - * the instance to set + * @param instance the instance to set */ public void setWorld(World instance) { world = instance; @@ -96,8 +94,7 @@ public abstract class DInstancePlayer extends DGlobalPlayer { /** * Makes the player send a message to the world. * - * @param message - * the message to send + * @param message the message to send */ public void chat(String message) { DInstanceWorld instance = plugin.getDWorlds().getInstanceByWorld(world); @@ -124,9 +121,7 @@ public abstract class DInstancePlayer extends DGlobalPlayer { /** * Repeating checks for the player. * - * @param updateSecond - * Not all checks have to be done as often as others; - * some are just done in "update seconds". + * @param updateSecond Not all checks have to be done as often as others; some are just done in "update seconds". */ public abstract void update(boolean updateSecond); diff --git a/src/main/java/de/erethon/dungeonsxl/player/DPermission.java b/src/main/java/de/erethon/dungeonsxl/player/DPermission.java index a8ff5d1a..46b48bd1 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DPermission.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DPermission.java @@ -137,10 +137,8 @@ public enum DPermission { } /** - * @param node - * the node String, with or without "dxl." - * @return - * the DPermission value + * @param node the node String, with or without "dxl." + * @return the DPermission value */ public static DPermission getByNode(String node) { for (DPermission permission : values()) { @@ -153,8 +151,8 @@ public enum DPermission { } /** - * @param permission - * the permission to check + * @param sender the CommandSender + * @param permission the permission to check * @return if the player has the permission */ public static boolean hasPermission(CommandSender sender, DPermission permission) { @@ -172,8 +170,8 @@ public enum DPermission { } /** - * @param permission - * the permission to check + * @param sender the CommandSender + * @param permission the permission to check * @return if the player has the permission */ public static boolean hasPermission(CommandSender sender, String permission) { diff --git a/src/main/java/de/erethon/dungeonsxl/player/DPlayerCache.java b/src/main/java/de/erethon/dungeonsxl/player/DPlayerCache.java index bfa0d26f..09a61ae4 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DPlayerCache.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DPlayerCache.java @@ -53,6 +53,7 @@ public class DPlayerCache { } /** + * @param player the player to check * @return the DGlobalPlayer which represents the player */ public DGlobalPlayer getByPlayer(Player player) { @@ -65,6 +66,7 @@ public class DPlayerCache { } /** + * @param uuid the unique ID to check * @return the DGlobalPlayer which represents the player with this UUID */ public DGlobalPlayer getByUniqueId(UUID uuid) { @@ -123,8 +125,7 @@ public class DPlayerCache { } /** - * @param player - * an instance of DGlobalPlayer to add + * @param player an instance of DGlobalPlayer to add */ public void addPlayer(DGlobalPlayer player) { removePlayer(player); @@ -132,8 +133,7 @@ public class DPlayerCache { } /** - * @param player - * an instance of DGlobalPlayer to remove + * @param player an instance of DGlobalPlayer to remove */ public void removePlayer(DGlobalPlayer player) { for (DGlobalPlayer dGlobalPlayer : dGlobalPlayers) { @@ -153,11 +153,9 @@ public class DPlayerCache { } /** - * Checks if an old DGamePlayer instance of the user exists. - * If yes, the old Player of the user is replaced with the new object. + * Checks if an old DGamePlayer instance of the user exists. If yes, the old Player of the user is replaced with the new object. * - * @param player - * the player to check + * @param player the player to check * @return if the player exists */ public boolean checkPlayer(Player player) { @@ -181,6 +179,8 @@ public class DPlayerCache { /** * start a new SecureModeTask + * + * @param period the period in ticks */ public void startSecureModeTask(long period) { secureModeTask = new SecureModeTask().runTaskTimer(plugin, period, period); @@ -195,6 +195,8 @@ public class DPlayerCache { /** * start a new LazyUpdateTask + * + * @param period the period in ticks */ public void startUpdateTask(long period) { updateTask = new UpdateTask().runTaskTimer(plugin, period, period); @@ -209,6 +211,8 @@ public class DPlayerCache { /** * start a new LazyUpdateTask + * + * @param period the period in ticks */ public void startLazyUpdateTask(long period) { lazyUpdateTask = new LazyUpdateTask().runTaskTimer(plugin, period, period); diff --git a/src/main/java/de/erethon/dungeonsxl/player/DPlayerData.java b/src/main/java/de/erethon/dungeonsxl/player/DPlayerData.java index 1c93651f..6f47f35b 100644 --- a/src/main/java/de/erethon/dungeonsxl/player/DPlayerData.java +++ b/src/main/java/de/erethon/dungeonsxl/player/DPlayerData.java @@ -96,8 +96,7 @@ public class DPlayerData extends DREConfig { } /** - * @param keepInventoryOnEscape - * set if the inventory shall be reset after a logout + * @param keepInventoryAfterLogout set if the inventory shall be reset after a logout */ public void setKeepInventoryAfterLogout(boolean keepInventoryAfterLogout) { this.keepInventoryAfterLogout = keepInventoryAfterLogout; @@ -116,8 +115,7 @@ public class DPlayerData extends DREConfig { } /** - * @param location - * the location to set + * @param location the location to set */ public void setOldLocation(Location location) { oldLocation = location; @@ -131,8 +129,7 @@ public class DPlayerData extends DREConfig { } /** - * @param inventory - * the inventory to set + * @param inventory the inventory to set */ public void setOldInventory(List inventory) { oldInventory = inventory; @@ -146,8 +143,7 @@ public class DPlayerData extends DREConfig { } /** - * @param inventory - * the inventory to set + * @param inventory the inventory to set */ public void setOldArmor(List inventory) { oldArmor = inventory; @@ -161,8 +157,7 @@ public class DPlayerData extends DREConfig { } /** - * @param offHand - * the off hand item to set + * @param offHand the off hand item to set */ public void setOldOffHand(ItemStack offHand) { oldOffHand = offHand; @@ -176,8 +171,7 @@ public class DPlayerData extends DREConfig { } /** - * @param level - * the level to set + * @param level the level to set */ public void setOldLevel(int level) { oldLvl = level; @@ -191,8 +185,7 @@ public class DPlayerData extends DREConfig { } /** - * @param exp - * the amount of exp to set + * @param exp the amount of exp to set */ public void setOldExp(float exp) { oldExp = exp; @@ -206,8 +199,7 @@ public class DPlayerData extends DREConfig { } /** - * @param maxHealth - * the maximum health to set + * @param maxHealth the maximum health to set */ public void setOldMaxHealth(double maxHealth) { oldMaxHealth = maxHealth; @@ -221,8 +213,7 @@ public class DPlayerData extends DREConfig { } /** - * @param health - * the health to set + * @param health the health to set */ public void setOldHealth(double health) { oldHealth = health; @@ -236,8 +227,7 @@ public class DPlayerData extends DREConfig { } /** - * @param foodLevel - * the food level to set + * @param foodLevel the food level to set */ public void setOldFoodLevel(int foodLevel) { oldFoodLevel = foodLevel; @@ -251,8 +241,7 @@ public class DPlayerData extends DREConfig { } /** - * @param fireTicks - * the fire ticks to set + * @param fireTicks the fire ticks to set */ public void setFireTicks(int fireTicks) { oldFireTicks = fireTicks; @@ -266,8 +255,7 @@ public class DPlayerData extends DREConfig { } /** - * @param gameMode - * the GameMode to set + * @param gameMode the GameMode to set */ public void setOldGameMode(GameMode gameMode) { oldGameMode = gameMode; @@ -281,8 +269,7 @@ public class DPlayerData extends DREConfig { } /** - * @param potionEffects - * the potion effects to set + * @param potionEffects the potion effects to set */ public void setOldPotionEffects(Collection potionEffects) { oldPotionEffects = potionEffects; @@ -296,8 +283,7 @@ public class DPlayerData extends DREConfig { } /** - * @param dungeon - * the dungeon to check + * @param dungeon the dungeon to check * @return the time when the player started the dungeon for the last time */ public long getTimeLastStarted(String dungeon) { @@ -310,10 +296,8 @@ public class DPlayerData extends DREConfig { } /** - * @param dungeon - * the started dungeon - * @param time - * the time when the dungeon was started + * @param dungeon the started dungeon + * @param time the time when the dungeon was started */ public void setTimeLastStarted(String dungeon, long time) { timeLastStarted.put(dungeon.toLowerCase(), time); @@ -328,8 +312,7 @@ public class DPlayerData extends DREConfig { } /** - * @param dungeon - * the dungeon to check + * @param dungeon the dungeon to check * @return the time when the player finished the dungeon for the last time */ public long getTimeLastFinished(String dungeon) { @@ -342,10 +325,8 @@ public class DPlayerData extends DREConfig { } /** - * @param dungeon - * the finished dungeon - * @param time - * the time when the dungeon was finished + * @param dungeon the finished dungeon + * @param time the time when the dungeon was finished */ public void setTimeLastFinished(String dungeon, long time) { timeLastFinished.put(dungeon.toLowerCase(), time); @@ -354,8 +335,7 @@ public class DPlayerData extends DREConfig { /* Actions */ /** - * @param dungeon - * the started dungeon + * @param dungeon the started dungeon */ public void logTimeLastStarted(String dungeon) { timeLastStarted.put(dungeon.toLowerCase(), System.currentTimeMillis()); @@ -363,8 +343,7 @@ public class DPlayerData extends DREConfig { } /** - * @param dungeon - * the finished dungeon + * @param dungeon the finished dungeon */ public void logTimeLastFinished(String dungeon) { timeLastFinished.put(dungeon.toLowerCase(), System.currentTimeMillis()); @@ -446,8 +425,7 @@ public class DPlayerData extends DREConfig { /** * Saves the player's data to the file. * - * @param player - * the Player to save + * @param player the Player to save */ public void savePlayerState(Player player) { oldGameMode = player.getGameMode(); diff --git a/src/main/java/de/erethon/dungeonsxl/requirement/FeeLevelRequirement.java b/src/main/java/de/erethon/dungeonsxl/requirement/FeeLevelRequirement.java index 3be683e7..f359e52c 100644 --- a/src/main/java/de/erethon/dungeonsxl/requirement/FeeLevelRequirement.java +++ b/src/main/java/de/erethon/dungeonsxl/requirement/FeeLevelRequirement.java @@ -44,8 +44,7 @@ public class FeeLevelRequirement extends Requirement { } /** - * @param fee - * the fee to set + * @param fee the fee to set */ public void setFee(int fee) { this.fee = fee; diff --git a/src/main/java/de/erethon/dungeonsxl/requirement/FeeMoneyRequirement.java b/src/main/java/de/erethon/dungeonsxl/requirement/FeeMoneyRequirement.java index 8075bca3..c3081dd4 100644 --- a/src/main/java/de/erethon/dungeonsxl/requirement/FeeMoneyRequirement.java +++ b/src/main/java/de/erethon/dungeonsxl/requirement/FeeMoneyRequirement.java @@ -42,8 +42,7 @@ public class FeeMoneyRequirement extends Requirement { } /** - * @param fee - * the fee to set + * @param fee the fee to set */ public void setFee(double fee) { this.fee = fee; diff --git a/src/main/java/de/erethon/dungeonsxl/requirement/GroupSizeRequirement.java b/src/main/java/de/erethon/dungeonsxl/requirement/GroupSizeRequirement.java index b5210a47..78b623ae 100644 --- a/src/main/java/de/erethon/dungeonsxl/requirement/GroupSizeRequirement.java +++ b/src/main/java/de/erethon/dungeonsxl/requirement/GroupSizeRequirement.java @@ -38,8 +38,7 @@ public class GroupSizeRequirement extends Requirement { } /** - * @param minimum - * the minimal group size to set + * @param minimum the minimal group size to set */ public void setMinimum(int minimum) { this.minimum = minimum; @@ -53,8 +52,7 @@ public class GroupSizeRequirement extends Requirement { } /** - * @param maximum - * the maximal group size to set + * @param maximum the maximal group size to set */ public void setMaximum(int maximum) { this.maximum = maximum; diff --git a/src/main/java/de/erethon/dungeonsxl/requirement/PermissionRequirement.java b/src/main/java/de/erethon/dungeonsxl/requirement/PermissionRequirement.java index 3d0ad731..e73fd4f3 100644 --- a/src/main/java/de/erethon/dungeonsxl/requirement/PermissionRequirement.java +++ b/src/main/java/de/erethon/dungeonsxl/requirement/PermissionRequirement.java @@ -40,8 +40,7 @@ public class PermissionRequirement extends Requirement { } /** - * @param permissions - * the permissions to set + * @param permissions the permissions to set */ public void setPermissions(List permissions) { this.permissions = permissions; diff --git a/src/main/java/de/erethon/dungeonsxl/requirement/RequirementTypeCache.java b/src/main/java/de/erethon/dungeonsxl/requirement/RequirementTypeCache.java index 46012f3e..54eaae0a 100644 --- a/src/main/java/de/erethon/dungeonsxl/requirement/RequirementTypeCache.java +++ b/src/main/java/de/erethon/dungeonsxl/requirement/RequirementTypeCache.java @@ -34,8 +34,8 @@ public class RequirementTypeCache { } /** - * @return - * the requirement type which has the identifier + * @param identifier the identifier to check + * @return the requirement type which has the identifier */ public RequirementType getByIdentifier(String identifier) { for (RequirementType type : types) { @@ -48,24 +48,21 @@ public class RequirementTypeCache { } /** - * @return - * the requirement types + * @return the requirement types */ public List getRequirements() { return types; } /** - * @param type - * the requirement type to add + * @param type the requirement type to add */ public void addRequirement(RequirementType type) { types.add(type); } /** - * @param type - * the requirement type to remove + * @param type the requirement type to remove */ public void removeRequirement(RequirementType type) { types.remove(type); diff --git a/src/main/java/de/erethon/dungeonsxl/reward/ItemReward.java b/src/main/java/de/erethon/dungeonsxl/reward/ItemReward.java index cc2c059b..5c24643c 100644 --- a/src/main/java/de/erethon/dungeonsxl/reward/ItemReward.java +++ b/src/main/java/de/erethon/dungeonsxl/reward/ItemReward.java @@ -40,24 +40,21 @@ public class ItemReward extends Reward { } /** - * @param items - * the reward items to set + * @param items the reward items to set */ public void setItems(List items) { this.items = items; } /** - * @param items - * the reward items to add + * @param items the reward items to add */ public void addItems(ItemStack... items) { this.items.addAll(Arrays.asList(items)); } /** - * @param items - * the reward items to remove + * @param items the reward items to remove */ public void removeItems(ItemStack... items) { this.items.addAll(Arrays.asList(items)); diff --git a/src/main/java/de/erethon/dungeonsxl/reward/LevelReward.java b/src/main/java/de/erethon/dungeonsxl/reward/LevelReward.java index eb064809..1dc72605 100644 --- a/src/main/java/de/erethon/dungeonsxl/reward/LevelReward.java +++ b/src/main/java/de/erethon/dungeonsxl/reward/LevelReward.java @@ -37,16 +37,14 @@ public class LevelReward extends Reward { } /** - * @param levels - * the levels to add + * @param levels the levels to add */ public void addLevels(int levels) { this.levels += levels; } /** - * @param levels - * the levels to set + * @param levels the levels to set */ public void setLevels(int levels) { this.levels = levels; diff --git a/src/main/java/de/erethon/dungeonsxl/reward/MoneyReward.java b/src/main/java/de/erethon/dungeonsxl/reward/MoneyReward.java index a5fba776..f79a5ad1 100644 --- a/src/main/java/de/erethon/dungeonsxl/reward/MoneyReward.java +++ b/src/main/java/de/erethon/dungeonsxl/reward/MoneyReward.java @@ -37,16 +37,14 @@ public class MoneyReward extends Reward { } /** - * @param money - * the money to add + * @param money the money to add */ public void addMoney(double money) { this.money += money; } /** - * @param money - * the money to set + * @param money the money to set */ public void setMoney(double money) { this.money = money; diff --git a/src/main/java/de/erethon/dungeonsxl/reward/RewardTypeCache.java b/src/main/java/de/erethon/dungeonsxl/reward/RewardTypeCache.java index e5459e71..3359e662 100644 --- a/src/main/java/de/erethon/dungeonsxl/reward/RewardTypeCache.java +++ b/src/main/java/de/erethon/dungeonsxl/reward/RewardTypeCache.java @@ -37,6 +37,7 @@ public class RewardTypeCache { } /** + * @param identifier the identifier to check * @return the reward type which has the identifier */ public RewardType getByIdentifier(String identifier) { @@ -57,16 +58,14 @@ public class RewardTypeCache { } /** - * @param type - * the reward type to add + * @param type the reward type to add */ public void addReward(RewardType type) { types.add(type); } /** - * @param type - * the reward type to remove + * @param type the reward type to remove */ public void removeReward(RewardType type) { types.remove(type); diff --git a/src/main/java/de/erethon/dungeonsxl/sign/BossShopSign.java b/src/main/java/de/erethon/dungeonsxl/sign/BossShopSign.java index 404a02c6..64141cbc 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/BossShopSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/BossShopSign.java @@ -52,8 +52,7 @@ public class BossShopSign extends DSign { } /** - * @param name - * the name of the shop + * @param name the name of the shop */ public void setShopName(String name) { shopName = name; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/ChestSign.java b/src/main/java/de/erethon/dungeonsxl/sign/ChestSign.java index c98f4db5..d1397ca9 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/ChestSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/ChestSign.java @@ -57,8 +57,7 @@ public class ChestSign extends DSign { } /** - * @param amount - * the amount to set + * @param amount the amount to set */ public void setMoneyReward(double amount) { moneyReward = amount; @@ -72,8 +71,7 @@ public class ChestSign extends DSign { } /** - * @param amount - * the amount to set + * @param amount the amount to set */ public void setLevelReward(int amount) { levelReward = amount; @@ -90,8 +88,7 @@ public class ChestSign extends DSign { } /** - * @param items - * the items to set as chest contents + * @param items the items to set as chest contents */ public void setItemReward(ItemStack[] items) { chestContent = items; @@ -105,8 +102,7 @@ public class ChestSign extends DSign { } /** - * @param lootTable - * the loot table to set + * @param lootTable the loot table to set */ public void setLootTable(LootTable lootTable) { this.lootTable = lootTable; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/DSign.java b/src/main/java/de/erethon/dungeonsxl/sign/DSign.java index 1aa67341..b45ed6fa 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/DSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/DSign.java @@ -96,8 +96,7 @@ public abstract class DSign { } /** - * @param sign - * the sign to set + * @param sign the sign to set */ public void setSign(Sign sign) { this.sign = sign; @@ -111,8 +110,7 @@ public abstract class DSign { } /** - * @param lines - * the sign lines to set + * @param lines the sign lines to set */ public void setLines(String[] lines) { this.lines = lines; @@ -140,16 +138,14 @@ public abstract class DSign { } /** - * @param trigger - * the trigger to add + * @param trigger the trigger to add */ public void addTrigger(Trigger trigger) { triggers.add(trigger); } /** - * @param trigger - * the trigger to remove + * @param trigger the trigger to remove */ public void removeTrigger(Trigger trigger) { triggers.remove(trigger); @@ -210,8 +206,7 @@ public abstract class DSign { /** * Set a placeholder to show that the sign is setup incorrectly. * - * @param reason - * the reason why the sign is marked as erroneous + * @param reason the reason why the sign is marked as erroneous */ public void markAsErroneous(String reason) { erroneous = true; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/DSignTypeCache.java b/src/main/java/de/erethon/dungeonsxl/sign/DSignTypeCache.java index 9b36879f..0ff9d6ca 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/DSignTypeCache.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/DSignTypeCache.java @@ -44,16 +44,14 @@ public class DSignTypeCache { } /** - * @param type - * the type to add + * @param type the type to add */ public void addDSign(DSignType type) { types.add(type); } /** - * @param type - * the type to remove + * @param type the type to remove */ public void removeDSign(DSignType type) { types.remove(type); diff --git a/src/main/java/de/erethon/dungeonsxl/sign/DropSign.java b/src/main/java/de/erethon/dungeonsxl/sign/DropSign.java index c88f3675..5617cbac 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/DropSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/DropSign.java @@ -48,8 +48,7 @@ public class DropSign extends DSign { } /** - * @param item - * the item to set + * @param item the item to set */ public void setItem(ItemStack item) { this.item = item; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/FloorSign.java b/src/main/java/de/erethon/dungeonsxl/sign/FloorSign.java index 13b56e00..22286c77 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/FloorSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/FloorSign.java @@ -47,8 +47,7 @@ public class FloorSign extends DSign { } /** - * @param floor - * the floor to set + * @param floor the floor to set */ public void setFloor(DResourceWorld floor) { this.floor = floor; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/LivesModifierSign.java b/src/main/java/de/erethon/dungeonsxl/sign/LivesModifierSign.java index 225413e1..04632c07 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/LivesModifierSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/LivesModifierSign.java @@ -57,8 +57,7 @@ public class LivesModifierSign extends DSign { } /** - * @param lives - * the lives to add / remove + * @param lives the lives to add / remove */ public void setLives(int lives) { this.lives = lives; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/LocationSign.java b/src/main/java/de/erethon/dungeonsxl/sign/LocationSign.java index 9b0ee997..9f40a547 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/LocationSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/LocationSign.java @@ -42,8 +42,7 @@ public abstract class LocationSign extends DSign { } /** - * @return - * the location marked by this sign + * @return the location marked by this sign */ public Location getLocation() { return location; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/OpenDoorSign.java b/src/main/java/de/erethon/dungeonsxl/sign/OpenDoorSign.java index c1263cba..e9726d6c 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/OpenDoorSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/OpenDoorSign.java @@ -48,8 +48,7 @@ public class OpenDoorSign extends DSign { } /** - * @param door - * the door to open + * @param door the door to open */ public void setDoor(LockedDoor door) { this.door = door; @@ -63,8 +62,7 @@ public class OpenDoorSign extends DSign { } /** - * @param active - * toggle the sign active + * @param active toggle the sign active */ public void setActive(boolean active) { this.active = active; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/PerPlayerSign.java b/src/main/java/de/erethon/dungeonsxl/sign/PerPlayerSign.java index e5cdfcbd..501b27ec 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/PerPlayerSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/PerPlayerSign.java @@ -40,10 +40,8 @@ public abstract class PerPlayerSign extends DSign { } /** - * @param player - * the player to check - * @return - * true if the player already triggered the sign + * @param player the player to check + * @return true if the player already triggered the sign */ public boolean isTriggeredByPlayer(Player player) { return triggered.contains(player.getUniqueId()); diff --git a/src/main/java/de/erethon/dungeonsxl/sign/RedstoneSign.java b/src/main/java/de/erethon/dungeonsxl/sign/RedstoneSign.java index b94fdf50..4b6870ff 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/RedstoneSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/RedstoneSign.java @@ -53,8 +53,7 @@ public class RedstoneSign extends DSign { } /** - * @param initialized - * the initialized to set + * @param initialized the initialized to set */ public void setInitialized(boolean initialized) { this.initialized = initialized; @@ -68,8 +67,7 @@ public class RedstoneSign extends DSign { } /** - * @param active - * the active to set + * @param active the active to set */ public void setActive(boolean active) { this.active = active; @@ -83,8 +81,7 @@ public class RedstoneSign extends DSign { } /** - * @param enableTask - * the enableTask to set + * @param enableTask the enableTask to set */ public void setEnableTask(BukkitTask enableTask) { this.enableTask = enableTask; @@ -98,8 +95,7 @@ public class RedstoneSign extends DSign { } /** - * @param disableTask - * the disableTask to set + * @param disableTask the disableTask to set */ public void setDisableTask(BukkitTask disableTask) { this.disableTask = disableTask; @@ -113,8 +109,7 @@ public class RedstoneSign extends DSign { } /** - * @param block - * the block to set + * @param block the block to set */ public void setBlock(Block block) { this.block = block; @@ -128,8 +123,7 @@ public class RedstoneSign extends DSign { } /** - * @param delay - * the delay to set + * @param delay the delay to set */ public void setDelay(long delay) { this.delay = delay; @@ -143,8 +137,7 @@ public class RedstoneSign extends DSign { } /** - * @param offDelay - * the offDelay to set + * @param offDelay the offDelay to set */ public void setOffDelay(long offDelay) { this.offDelay = offDelay; @@ -158,8 +151,7 @@ public class RedstoneSign extends DSign { } /** - * @param repeat - * the repeat to set + * @param repeat the repeat to set */ public void setRepeat(int repeat) { this.repeat = repeat; @@ -173,8 +165,7 @@ public class RedstoneSign extends DSign { } /** - * @param repeatsToDo - * the repeatsToDo to set + * @param repeatsToDo the repeatsToDo to set */ public void setRepeatsToDo(int repeatsToDo) { this.repeatsToDo = repeatsToDo; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/ResourcePackSign.java b/src/main/java/de/erethon/dungeonsxl/sign/ResourcePackSign.java index bdbb576c..c9a0300c 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/ResourcePackSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/ResourcePackSign.java @@ -51,8 +51,7 @@ public class ResourcePackSign extends DSign { } /** - * @param resourcePack - * the resource pack to set + * @param resourcePack the resource pack to set */ public void setExternalMob(String resourcePack) { this.resourcePack = resourcePack; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/SignScript.java b/src/main/java/de/erethon/dungeonsxl/sign/SignScript.java index 8de0731e..9236ed86 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/SignScript.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/SignScript.java @@ -24,8 +24,7 @@ import org.bukkit.configuration.file.FileConfiguration; import org.bukkit.configuration.file.YamlConfiguration; /** - * Representation of a sign script. - * Sign scripts allow to merge multiple dungeon signs at one position. + * Representation of a sign script. Sign scripts allow to merge multiple dungeon signs at one position. * * @author Daniel Saukel */ @@ -36,18 +35,15 @@ public class SignScript { private List signs; /** - * @param file - * the script file + * @param file the script file */ public SignScript(File file) { this(file.getName().substring(0, file.getName().length() - 4), YamlConfiguration.loadConfiguration(file)); } /** - * @param name - * the name of the Announcer - * @param config - * the config that stores the information + * @param name the name of the Announcer + * @param config the config that stores the information */ public SignScript(String name, FileConfiguration config) { this.name = name; @@ -76,8 +72,7 @@ public class SignScript { } /** - * @param index - * the index number + * @param index the index number * @return the lines of the sign */ public String[] getLines(int index) { @@ -85,10 +80,8 @@ public class SignScript { } /** - * @param index - * the index number - * @param lines - * the lines to set + * @param index the index number + * @param lines the lines to set */ public void setLines(int index, String[] lines) { signs.set(index, lines); diff --git a/src/main/java/de/erethon/dungeonsxl/sign/SignScriptCache.java b/src/main/java/de/erethon/dungeonsxl/sign/SignScriptCache.java index cf3850c2..c3a5af25 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/SignScriptCache.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/SignScriptCache.java @@ -39,6 +39,7 @@ public class SignScriptCache { } /** + * @param name the name to check * @return the script that has the name */ public SignScript getByName(String name) { @@ -59,16 +60,14 @@ public class SignScriptCache { } /** - * @param script - * the SignScript to add + * @param script the SignScript to add */ public void addScript(SignScript script) { scripts.add(script); } /** - * @param script - * the SignScript to remove + * @param script the SignScript to remove */ public void removeScript(SignScript script) { scripts.remove(script); diff --git a/src/main/java/de/erethon/dungeonsxl/sign/WaveSign.java b/src/main/java/de/erethon/dungeonsxl/sign/WaveSign.java index a2022228..3672eb24 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/WaveSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/WaveSign.java @@ -47,8 +47,7 @@ public class WaveSign extends DSign { } /** - * @param mobCountIncreaseRate - * the mobCountIncreaseRate to set + * @param mobCountIncreaseRate the mobCountIncreaseRate to set */ public void setMobCountIncreaseRate(double mobCountIncreaseRate) { this.mobCountIncreaseRate = mobCountIncreaseRate; @@ -62,8 +61,7 @@ public class WaveSign extends DSign { } /** - * @param teleport - * Set if the players shall get teleported to the start location + * @param teleport Set if the players shall get teleported to the start location */ public void setTeleport(boolean teleport) { this.teleport = teleport; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/lobby/ClassesSign.java b/src/main/java/de/erethon/dungeonsxl/sign/lobby/ClassesSign.java index 2ca64680..b6102a01 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/lobby/ClassesSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/lobby/ClassesSign.java @@ -47,8 +47,7 @@ public class ClassesSign extends DSign { } /** - * @param dClass - * the DClass to set + * @param dClass the DClass to set */ public void setDClass(DClass dClass) { this.dClass = dClass; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/lobby/ReadySign.java b/src/main/java/de/erethon/dungeonsxl/sign/lobby/ReadySign.java index 67c4e6e0..ba0e70d4 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/lobby/ReadySign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/lobby/ReadySign.java @@ -58,8 +58,7 @@ public class ReadySign extends DSign { } /** - * @param gameType - * the gameType to set + * @param gameType the gameType to set */ public void setGameType(GameType gameType) { this.gameType = gameType; @@ -73,8 +72,7 @@ public class ReadySign extends DSign { } /** - * @param time - * the time in seconds until the game starts automatically; -1 for no auto start + * @param time the time in seconds until the game starts automatically; -1 for no auto start */ public void setTimeToAutoStart(double time) { autoStart = time; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/lobby/StartSign.java b/src/main/java/de/erethon/dungeonsxl/sign/lobby/StartSign.java index cb7346aa..008ba117 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/lobby/StartSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/lobby/StartSign.java @@ -46,8 +46,7 @@ public class StartSign extends LocationSign { } /** - * @param id - * the ID to set + * @param id the ID to set */ public void setId(int id) { this.id = id; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/message/ActionBarSign.java b/src/main/java/de/erethon/dungeonsxl/sign/message/ActionBarSign.java index eb1491db..42d0eb79 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/message/ActionBarSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/message/ActionBarSign.java @@ -40,16 +40,14 @@ public class ActionBarSign extends PerPlayerSign { /* Getters and setters*/ /** - * @return - * the text + * @return the text */ public String getText() { return text; } /** - * @param text - * the text to set + * @param text the text to set */ public void setText(String text) { this.text = text; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/message/TitleSign.java b/src/main/java/de/erethon/dungeonsxl/sign/message/TitleSign.java index 03454625..bdb7df78 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/message/TitleSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/message/TitleSign.java @@ -41,32 +41,28 @@ public class TitleSign extends PerPlayerSign { /* Getters and setters*/ /** - * @return - * the title + * @return the title */ public String getTitle() { return title; } /** - * @param text - * the text to set + * @param text the text to set */ public void setTitle(String text) { title = text; } /** - * @return - * the subtitle + * @return the subtitle */ public String getSubtitle() { return subtitle; } /** - * @param text - * the text to set + * @param text the text to set */ public void setSubtitle(String text) { subtitle = text; diff --git a/src/main/java/de/erethon/dungeonsxl/sign/mob/ExternalMobSign.java b/src/main/java/de/erethon/dungeonsxl/sign/mob/ExternalMobSign.java index bab91af0..a89ec9de 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/mob/ExternalMobSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/mob/ExternalMobSign.java @@ -151,8 +151,7 @@ public class ExternalMobSign extends DSign implements MobSign { } /** - * @param spawnLocation - * the spawnLocation to set + * @param spawnLocation the spawnLocation to set */ public void setSpawnLocation(Location spawnLocation) { this.spawnLocation = spawnLocation; @@ -166,8 +165,7 @@ public class ExternalMobSign extends DSign implements MobSign { } /** - * @param externalMob - * the external mob to set + * @param externalMob the external mob to set */ public void setExternalMob(LivingEntity externalMob) { this.externalMob = externalMob; @@ -181,16 +179,14 @@ public class ExternalMobSign extends DSign implements MobSign { } /** - * @param externalMob - * the externalMob to add + * @param externalMob the externalMob to add */ public void addExternalMob(Entity externalMob) { externalMobs.add(externalMob); } /** - * @param externalMob - * the external mob to remove + * @param externalMob the external mob to remove */ public void removeExternalMob(Entity externalMob) { externalMobs.remove(externalMob); diff --git a/src/main/java/de/erethon/dungeonsxl/sign/mob/MobSign.java b/src/main/java/de/erethon/dungeonsxl/sign/mob/MobSign.java index 22877d9f..7b90fd14 100644 --- a/src/main/java/de/erethon/dungeonsxl/sign/mob/MobSign.java +++ b/src/main/java/de/erethon/dungeonsxl/sign/mob/MobSign.java @@ -29,8 +29,7 @@ public interface MobSign { public String getMob(); /** - * @param mob - * the mob to set + * @param mob the mob to set */ public void setMob(String mob); @@ -40,8 +39,7 @@ public interface MobSign { public int getMaxInterval(); /** - * @param maxInterval - * the maximum interval between mob spawns + * @param maxInterval the maximum interval between mob spawns */ public void setMaxInterval(int maxInterval); @@ -51,8 +49,7 @@ public interface MobSign { public int getInterval(); /** - * @param interval - * the spawn interval + * @param interval the spawn interval */ public void setInterval(int interval); @@ -62,8 +59,7 @@ public interface MobSign { public int getAmount(); /** - * @param amount - * the amount of mobs to set + * @param amount the amount of mobs to set */ public void setAmount(int amount); @@ -73,8 +69,7 @@ public interface MobSign { public int getInitialAmount(); /** - * @param amount - * the amount of mobs to set + * @param amount the amount of mobs to set */ public void setInitialAmount(int initialAmount); @@ -84,8 +79,7 @@ public interface MobSign { public boolean isInitialized(); /** - * @param initialized - * set the sign initialized + * @param initialized set the sign initialized */ public void setInitialized(boolean initialized); @@ -95,8 +89,7 @@ public interface MobSign { public boolean isActive(); /** - * @param active - * set the sign active + * @param active set the sign active */ public void setActive(boolean active); @@ -106,8 +99,7 @@ public interface MobSign { public BukkitTask getTask(); /** - * @param task - * the task to set + * @param task the task to set */ public void setTask(BukkitTask task); diff --git a/src/main/java/de/erethon/dungeonsxl/trigger/FortuneTrigger.java b/src/main/java/de/erethon/dungeonsxl/trigger/FortuneTrigger.java index c397157a..8b3077e4 100644 --- a/src/main/java/de/erethon/dungeonsxl/trigger/FortuneTrigger.java +++ b/src/main/java/de/erethon/dungeonsxl/trigger/FortuneTrigger.java @@ -44,8 +44,7 @@ public class FortuneTrigger extends Trigger { } /** - * @param chance - * the chance to set + * @param chance the chance to set */ public void setChance(double chance) { this.chance = chance; diff --git a/src/main/java/de/erethon/dungeonsxl/trigger/ProgressTrigger.java b/src/main/java/de/erethon/dungeonsxl/trigger/ProgressTrigger.java index 68b6f5c9..53f59618 100644 --- a/src/main/java/de/erethon/dungeonsxl/trigger/ProgressTrigger.java +++ b/src/main/java/de/erethon/dungeonsxl/trigger/ProgressTrigger.java @@ -53,8 +53,7 @@ public class ProgressTrigger extends Trigger { } /** - * @param floor - * the specific floor to set + * @param floor the specific floor to set */ public void setFloor(DResourceWorld floor) { this.floor = floor; @@ -68,8 +67,7 @@ public class ProgressTrigger extends Trigger { } /** - * @param floorCount - * the floor count to set + * @param floorCount the floor count to set */ public void setFloorCount(int floorCount) { this.floorCount = floorCount; @@ -83,8 +81,7 @@ public class ProgressTrigger extends Trigger { } /** - * @param waveCount - * the wave count to set + * @param waveCount the wave count to set */ public void setWaveCount(int waveCount) { this.waveCount = waveCount; diff --git a/src/main/java/de/erethon/dungeonsxl/trigger/Trigger.java b/src/main/java/de/erethon/dungeonsxl/trigger/Trigger.java index 6421fc83..83c302ff 100644 --- a/src/main/java/de/erethon/dungeonsxl/trigger/Trigger.java +++ b/src/main/java/de/erethon/dungeonsxl/trigger/Trigger.java @@ -49,8 +49,7 @@ public abstract class Trigger { } /** - * @param triggered - * the triggered to set + * @param triggered the triggered to set */ public void setTriggered(boolean triggered) { this.triggered = triggered; @@ -64,8 +63,7 @@ public abstract class Trigger { } /** - * @param player - * the player to set + * @param player the player to set */ public void setPlayer(Player player) { this.player = player; @@ -79,16 +77,14 @@ public abstract class Trigger { } /** - * @param dSign - * the dSign to add + * @param dSign the dSign to add */ public void addDSign(DSign dSign) { dSigns.add(dSign); } /** - * @param dSign - * the dSign to remove + * @param dSign the dSign to remove */ public void removeDSign(DSign dSign) { dSigns.remove(dSign); diff --git a/src/main/java/de/erethon/dungeonsxl/trigger/TriggerTypeCache.java b/src/main/java/de/erethon/dungeonsxl/trigger/TriggerTypeCache.java index 22d07d54..6630a40f 100644 --- a/src/main/java/de/erethon/dungeonsxl/trigger/TriggerTypeCache.java +++ b/src/main/java/de/erethon/dungeonsxl/trigger/TriggerTypeCache.java @@ -37,6 +37,7 @@ public class TriggerTypeCache { } /** + * @param identifier the identifier to check * @return the trigger which has the identifier */ public TriggerType getByIdentifier(String identifier) { @@ -57,16 +58,14 @@ public class TriggerTypeCache { } /** - * @param type - * the type to add + * @param type the type to add */ public void addTrigger(TriggerType type) { types.add(type); } /** - * @param type - * the type to remove + * @param type the type to remove */ public void removeTrigger(TriggerType type) { types.remove(type); diff --git a/src/main/java/de/erethon/dungeonsxl/trigger/WaveTrigger.java b/src/main/java/de/erethon/dungeonsxl/trigger/WaveTrigger.java index 3bd757ef..3af3d402 100644 --- a/src/main/java/de/erethon/dungeonsxl/trigger/WaveTrigger.java +++ b/src/main/java/de/erethon/dungeonsxl/trigger/WaveTrigger.java @@ -43,8 +43,7 @@ public class WaveTrigger extends Trigger { } /** - * @param mustKillRate - * the minimal mob kill rate to trigger the wave to set + * @param mustKillRate the minimal mob kill rate to trigger the wave to set */ public void setMustKillRate(double mustKillRate) { this.mustKillRate = mustKillRate; @@ -74,6 +73,7 @@ public class WaveTrigger extends Trigger { } /** + * @param gameWorld the game world to check * @return the WaveTriggers in the DGameWorld */ public static Set getByGameWorld(DGameWorld gameWorld) { diff --git a/src/main/java/de/erethon/dungeonsxl/util/DColor.java b/src/main/java/de/erethon/dungeonsxl/util/DColor.java index a06f5f1b..ff032529 100644 --- a/src/main/java/de/erethon/dungeonsxl/util/DColor.java +++ b/src/main/java/de/erethon/dungeonsxl/util/DColor.java @@ -93,8 +93,7 @@ public enum DColor { } /** - * @param color - * the DyeColor to check + * @param color the DyeColor to check * @return the matching DColor or null */ public static DColor getByDyeColor(DyeColor color) { @@ -107,8 +106,7 @@ public enum DColor { } /** - * @param color - * the ChatColor to check + * @param color the ChatColor to check * @return the matching DColor or null */ public static DColor getByChatColor(ChatColor color) { diff --git a/src/main/java/de/erethon/dungeonsxl/util/GUIUtil.java b/src/main/java/de/erethon/dungeonsxl/util/GUIUtil.java index 579d1631..083e12b7 100644 --- a/src/main/java/de/erethon/dungeonsxl/util/GUIUtil.java +++ b/src/main/java/de/erethon/dungeonsxl/util/GUIUtil.java @@ -43,8 +43,7 @@ public enum GUIUtil { } /** - * @param count - * the amount of buttons + * @param count the amount of buttons */ public static GUIUtil getRowShapeByButtonCount(int count) { if (count >= 1 && count <= 9) { @@ -59,26 +58,20 @@ public enum GUIUtil { } /** - * @param buttons - * the buttons to use for the GUI - * @return - * an Inventory that can easily be shown to a Player + * @param plugin the plugin instance + * @param title the title for the GUI + * @param buttons the buttons to use for the GUI + * @return an Inventory that can easily be shown to a Player */ public static Inventory createGUI(DungeonsXL plugin, String title, ItemStack... buttons) { return createGUI(plugin, title, Arrays.asList(buttons)); } /** - * @param plugin - * the plugin instance - * @param title - * the GUI title, may contain color codes - * @param buttons - * the buttons to use for the GUI - * @param close - * if the GUI may get closed by the viewer - * @return - * an Inventory that can easily be shown to a Player + * @param plugin the plugin instance + * @param title the GUI title, may contain color codes + * @param buttons the buttons to use for the GUI + * @return an Inventory that can easily be shown to a Player */ public static Inventory createGUI(DungeonsXL plugin, String title, List buttons) { int rows = (int) Math.ceil(((double) buttons.size()) / 9); diff --git a/src/main/java/de/erethon/dungeonsxl/util/LWCUtil.java b/src/main/java/de/erethon/dungeonsxl/util/LWCUtil.java index 5a107cd4..f1c0a4e1 100644 --- a/src/main/java/de/erethon/dungeonsxl/util/LWCUtil.java +++ b/src/main/java/de/erethon/dungeonsxl/util/LWCUtil.java @@ -26,8 +26,7 @@ public class LWCUtil { } /** - * @return - * true if LWC is loaded + * @return true if LWC is loaded */ public static boolean isLWCLoaded() { return Bukkit.getPluginManager().getPlugin("LWC") != null; diff --git a/src/main/java/de/erethon/dungeonsxl/util/NoReload.java b/src/main/java/de/erethon/dungeonsxl/util/NoReload.java index 4095ddf7..0dffbb85 100644 --- a/src/main/java/de/erethon/dungeonsxl/util/NoReload.java +++ b/src/main/java/de/erethon/dungeonsxl/util/NoReload.java @@ -34,8 +34,7 @@ public class NoReload implements Listener { Plugin plugin; /** - * @param plugin - * the plugin that integrates NoReload + * @param plugin the plugin that integrates NoReload */ public NoReload(Plugin plugin) { this.plugin = plugin; diff --git a/src/main/java/de/erethon/dungeonsxl/util/ParsingUtil.java b/src/main/java/de/erethon/dungeonsxl/util/ParsingUtil.java index fff3cc35..0f1e6e2a 100644 --- a/src/main/java/de/erethon/dungeonsxl/util/ParsingUtil.java +++ b/src/main/java/de/erethon/dungeonsxl/util/ParsingUtil.java @@ -51,10 +51,9 @@ public enum ParsingUtil { /** * Replace the placeholders that are relevant for the chat in a String automatically. * - * @param string - * the String that contains the placeholders - * @param sender - * the DGlobalPlayer who sent the message + * @param string the String that contains the placeholders + * @param sender the DGlobalPlayer who sent the message + * @return the string with the placeholders replaced */ public static String replaceChatPlaceholders(String string, DGlobalPlayer sender) { DGroup group = DGroup.getByPlayer(sender.getPlayer()); diff --git a/src/main/java/de/erethon/dungeonsxl/util/ProgressBar.java b/src/main/java/de/erethon/dungeonsxl/util/ProgressBar.java index 4bc5e3db..cb1a7877 100644 --- a/src/main/java/de/erethon/dungeonsxl/util/ProgressBar.java +++ b/src/main/java/de/erethon/dungeonsxl/util/ProgressBar.java @@ -55,16 +55,14 @@ public class ProgressBar extends BukkitRunnable { } /** - * @param player - * the player to add + * @param player the player to add */ public void addPlayer(Player player) { players.add(player.getUniqueId()); } /** - * @param player - * the player to remove + * @param player the player to remove */ public void removePlayer(Player player) { players.remove(player.getUniqueId()); diff --git a/src/main/java/de/erethon/dungeonsxl/world/DEditWorld.java b/src/main/java/de/erethon/dungeonsxl/world/DEditWorld.java index d2eb3508..4984e0e7 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/DEditWorld.java +++ b/src/main/java/de/erethon/dungeonsxl/world/DEditWorld.java @@ -30,8 +30,7 @@ import org.bukkit.block.Sign; import org.bukkit.scheduler.BukkitRunnable; /** - * A raw resource world instance to edit the dungeon map. - * There is never more than one DEditWorld per DResourceWorld. + * A raw resource world instance to edit the dungeon map. There is never more than one DEditWorld per DResourceWorld. * * @author Frank Baumann, Daniel Saukel */ @@ -61,7 +60,7 @@ public class DEditWorld extends DInstanceWorld { } /** - * @return the ID file + * Generates an ID file for identification upon server restarts */ public void generateIdFile() { try { @@ -81,8 +80,7 @@ public class DEditWorld extends DInstanceWorld { } /** - * @param sign - * the sign to set + * @param signs the sign to set */ public void setSigns(CopyOnWriteArrayList signs) { this.signs = signs; @@ -92,8 +90,7 @@ public class DEditWorld extends DInstanceWorld { /** * Registers the block as a DSign sothat it can later be saved persistently. * - * @param block - * a DSign block + * @param block a DSign block */ public void registerSign(Block block) { if (block.getState() instanceof Sign) { @@ -144,8 +141,7 @@ public class DEditWorld extends DInstanceWorld { /** * Deletes this edit instance. * - * @param save - * whether this world should be saved + * @param save whether this world should be saved */ public void delete(final boolean save) { EditWorldUnloadEvent event = new EditWorldUnloadEvent(this, true); @@ -191,20 +187,16 @@ public class DEditWorld extends DInstanceWorld { /* Statics */ /** - * @param world - * the instance - * @return - * the DEditWorld that represents the world + * @param world the instance + * @return the DEditWorld that represents the world */ public static DEditWorld getByWorld(World world) { return getByName(world.getName()); } /** - * @param world - * the instance name - * @return - * the DEditWorld that represents the world + * @param name the instance name + * @return the DEditWorld that represents the world */ public static DEditWorld getByName(String name) { DInstanceWorld instance = DungeonsXL.getInstance().getDWorlds().getInstanceByName(name); diff --git a/src/main/java/de/erethon/dungeonsxl/world/DGameWorld.java b/src/main/java/de/erethon/dungeonsxl/world/DGameWorld.java index d5d4b0c1..daa337d0 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/DGameWorld.java +++ b/src/main/java/de/erethon/dungeonsxl/world/DGameWorld.java @@ -72,8 +72,7 @@ import org.bukkit.inventory.ItemStack; import org.bukkit.scheduler.BukkitRunnable; /** - * A playable resource instance. - * There may be any amount of DGameWorlds per DResourceWorld. + * A playable resource instance. There may be any amount of DGameWorlds per DResourceWorld. * * @author Frank Baumann, Milan Albrecht, Daniel Saukel */ @@ -119,8 +118,7 @@ public class DGameWorld extends DInstanceWorld { } /** - * @return - * the Game connected to the DGameWorld + * @return the Game connected to the DGameWorld */ public Game getGame() { if (game == null) { @@ -135,16 +133,14 @@ public class DGameWorld extends DInstanceWorld { } /** - * @return - * the type of the floor + * @return the type of the floor */ public Type getType() { return type; } /** - * @param type - * the type to set + * @param type the type to set */ public void setType(Type type) { this.type = type; @@ -158,14 +154,16 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param isPlaying - * the isPlaying to set + * @param isPlaying the isPlaying to set */ public void setPlaying(boolean isPlaying) { this.isPlaying = isPlaying; } /** + * Returns the start location of the respective group. + * + * @param dGroup the group * @return the start location */ public Location getStartLocation(DGroup dGroup) { @@ -203,8 +201,7 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param gameBlock - * the gameBlock to add + * @param gameBlock the gameBlock to add */ public void addGameBlock(GameBlock gameBlock) { gameBlocks.add(gameBlock); @@ -223,8 +220,7 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param gameBlock - * the gameBlock to remove + * @param gameBlock the gameBlock to remove */ public void removeGameBlock(GameBlock gameBlock) { gameBlocks.remove(gameBlock); @@ -285,8 +281,7 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param secureObjects - * the secureObjects to set + * @param secureObjects the secureObjects to set */ public void setSecureObjects(List secureObjects) { this.secureObjects = secureObjects; @@ -300,8 +295,7 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param loadedChunks - * the loadedChunks to set + * @param loadedChunks the loadedChunks to set */ public void setLoadedChunks(CopyOnWriteArrayList loadedChunks) { this.loadedChunks = loadedChunks; @@ -315,8 +309,7 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param classes signs - * the classes signs to set + * @param signs the classes signs to set */ public void setClasses(CopyOnWriteArrayList signs) { classesSigns = signs; @@ -330,16 +323,14 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param dMob - * the dMob to add + * @param dMob the dMob to add */ public void addDMob(DMob dMob) { dMobs.add(dMob); } /** - * @param dMob - * the dMob to remove + * @param dMob the dMob to remove */ public void removeDMob(DMob dMob) { dMobs.remove(dMob); @@ -353,6 +344,7 @@ public class DGameWorld extends DInstanceWorld { } /** + * @param type the DSignType to filter * @return the triggers with the type */ public List getDSigns(DSignType type) { @@ -366,8 +358,7 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param dSigns - * the dSigns to set + * @param dSigns the dSigns to set */ public void setDSigns(CopyOnWriteArrayList dSigns) { this.dSigns = dSigns; @@ -381,6 +372,7 @@ public class DGameWorld extends DInstanceWorld { } /** + * @param type the type to filter * @return the triggers with the type */ public List getTriggers(TriggerType type) { @@ -394,16 +386,14 @@ public class DGameWorld extends DInstanceWorld { } /** - * @param trigger - * the trigger to add + * @param trigger the trigger to add */ public void addTrigger(Trigger trigger) { triggers.add(trigger); } /** - * @param trigger - * the trigger to remove + * @param trigger the trigger to remove */ public void removeTrigger(Trigger trigger) { triggers.remove(trigger); @@ -546,8 +536,7 @@ public class DGameWorld extends DInstanceWorld { /** * Handles what happens when a player breaks a block. * - * @param event - * the passed Bukkit event + * @param event the passed Bukkit event * @return if the event is cancelled */ public boolean onBreak(BlockBreakEvent event) { @@ -629,8 +618,7 @@ public class DGameWorld extends DInstanceWorld { * @param player * @param block * @param against - * @param hand - * the event parameters. + * @param hand the event parameters. * @return if the event is cancelled */ public boolean onPlace(Player player, Block block, Block against, ItemStack hand) { @@ -668,10 +656,8 @@ public class DGameWorld extends DInstanceWorld { /* Statics */ /** - * @param world - * the instance - * @return - * the EditWorld that represents the world + * @param world the instance + * @return the EditWorld that represents the world */ public static DGameWorld getByWorld(World world) { DInstanceWorld instance = DungeonsXL.getInstance().getDWorlds().getInstanceByName(world.getName()); diff --git a/src/main/java/de/erethon/dungeonsxl/world/DInstanceWorld.java b/src/main/java/de/erethon/dungeonsxl/world/DInstanceWorld.java index 1b296d9e..25eb41c7 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/DInstanceWorld.java +++ b/src/main/java/de/erethon/dungeonsxl/world/DInstanceWorld.java @@ -112,16 +112,14 @@ public abstract class DInstanceWorld { } /** - * @param lobby - * the spawn location to set + * @param lobby the spawn location to set */ public void setLobbyLocation(Location lobby) { this.lobby = lobby; } /** - * @return - * the players in this world + * @return the players in this world */ public Collection getPlayers() { Collection players = new ArrayList<>(); @@ -137,8 +135,7 @@ public abstract class DInstanceWorld { /** * Sends a message to all players in the instance. * - * @param message - * the message to send + * @param message the message to send */ public void sendMessage(String message) { for (DGamePlayer dPlayer : DGamePlayer.getByWorld(world)) { @@ -147,9 +144,7 @@ public abstract class DInstanceWorld { } /** - * Makes all players leave the world. - * Attempts to let them leave properly if they are correct DInstancePlayers; - * teleports them to the spawn if they are not. + * Makes all players leave the world. Attempts to let them leave properly if they are correct DInstancePlayers; teleports them to the spawn if they are not. */ public void kickAllPlayers() { getPlayers().forEach(p -> p.leave()); @@ -158,8 +153,7 @@ public abstract class DInstanceWorld { } /** - * @param rules - * sets up the time and weather to match the rules + * @param rules sets up the time and weather to match the rules */ public void setWeather(GameRuleProvider rules) { if (world == null) { diff --git a/src/main/java/de/erethon/dungeonsxl/world/DResourceWorld.java b/src/main/java/de/erethon/dungeonsxl/world/DResourceWorld.java index e0851678..336d5dd3 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/DResourceWorld.java +++ b/src/main/java/de/erethon/dungeonsxl/world/DResourceWorld.java @@ -93,8 +93,7 @@ public class DResourceWorld { } /** - * @param name - * the name to set + * @param name the name to set */ public void setName(String name) { folder.renameTo(new File(folder.getParentFile(), name)); @@ -109,8 +108,7 @@ public class DResourceWorld { } /** - * @param generate - * if a config should be generated if none exists + * @param generate if a config should be generated if none exists * @return the WorldConfig */ public WorldConfig getConfig(boolean generate) { @@ -141,8 +139,7 @@ public class DResourceWorld { } /** - * @param player - * the player to invite + * @param player the player to invite */ public void addInvitedPlayer(OfflinePlayer player) { if (config == null) { @@ -154,8 +151,8 @@ public class DResourceWorld { } /** - * @param player - * the player to uninvite + * @param player the player to uninvite + * @return if the action was successful */ public boolean removeInvitedPlayer(OfflinePlayer player) { if (config == null) { @@ -176,8 +173,8 @@ public class DResourceWorld { } /** - * @param player - * the player to check + * @param player the player to check + * @return if the player is invited */ public boolean isInvitedPlayer(OfflinePlayer player) { if (config == null) { @@ -191,8 +188,7 @@ public class DResourceWorld { /** * Creates a backup of the resource * - * @param async - * whether the task shall be performed asyncronously + * @param async whether the task shall be performed asyncronously */ public void backup(boolean async) { BackupResourceTask task = new BackupResourceTask(this); @@ -204,8 +200,7 @@ public class DResourceWorld { } /** - * @param game - * whether the instance is a DGameWorld + * @param game whether the instance is a DGameWorld * @return an instance of this world */ public DInstanceWorld instantiate(final boolean game) { diff --git a/src/main/java/de/erethon/dungeonsxl/world/DWorldCache.java b/src/main/java/de/erethon/dungeonsxl/world/DWorldCache.java index 5284fb4d..f817c0d2 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/DWorldCache.java +++ b/src/main/java/de/erethon/dungeonsxl/world/DWorldCache.java @@ -68,6 +68,7 @@ public class DWorldCache { /* Getters and setters */ /** + * @param name the name to check * @return the DResourceWorld that has this name */ public DResourceWorld getResourceByName(String name) { @@ -81,6 +82,7 @@ public class DWorldCache { } /** + * @param world the world to check * @return the DInstanceWorld that represents this world */ public DInstanceWorld getInstanceByWorld(World world) { @@ -88,6 +90,7 @@ public class DWorldCache { } /** + * @param name the name to check * @return the DInstanceWorld that has this name */ public DInstanceWorld getInstanceByName(String name) { @@ -100,6 +103,7 @@ public class DWorldCache { } /** + * @param id the ID to check * @return the DInstanceWorld that has this ID */ public DInstanceWorld getInstanceById(int id) { @@ -120,16 +124,14 @@ public class DWorldCache { } /** - * @param resource - * the DResourceWorld to add + * @param resource the DResourceWorld to add */ public void addResource(DResourceWorld resource) { resources.add(resource); } /** - * @param resource - * the DResourceWorld to remove + * @param resource the DResourceWorld to remove */ public void removeResource(DResourceWorld resource) { resources.remove(resource); @@ -143,16 +145,14 @@ public class DWorldCache { } /** - * @param instance - * the DInstanceWorld to add + * @param instance the DInstanceWorld to add */ public void addInstance(DInstanceWorld instance) { instances.add(instance); } /** - * @param instance - * the DInstanceWorld to remove + * @param instance the DInstanceWorld to remove */ public void removeInstance(DInstanceWorld instance) { instances.remove(instance); @@ -185,10 +185,8 @@ public class DWorldCache { } /** - * @param name - * the name of the map; can either be the resource name or the instance name - * @return - * if a map with this name exists + * @param name the name of the map; can either be the resource name or the instance name + * @return if a map with this name exists */ public boolean exists(String name) { for (DResourceWorld resource : resources) { @@ -283,22 +281,17 @@ public class DWorldCache { } /** - * @return - * a name for the instance - * @param game - * whether the instance is a DGameWorld + * @return a name for the instance + * @param game whether the instance is a DGameWorld */ public String generateName(boolean game) { return generateName(game, generateId()); } /** - * @return - * a name for the instance - * @param game - * whether the instance is a DGameWorld - * @param id - * the id to use + * @return a name for the instance + * @param game whether the instance is a DGameWorld + * @param id the id to use */ public String generateName(boolean game, int id) { return "DXL_" + (game ? "Game" : "Edit") + "_" + id; @@ -328,6 +321,8 @@ public class DWorldCache { /** * start a new WorldUnloadTask + * + * @param period the period in ticks */ public void startWorldUnloadTask(long period) { worldUnloadTask = new WorldUnloadTask().runTaskTimer(plugin, period, period); @@ -337,8 +332,7 @@ public class DWorldCache { /** * Removes files that are not needed from a world * - * @param dir - * the directory to purge + * @param dir the directory to purge */ public static void deleteUnusedFiles(File dir) { File[] files = dir.listFiles(); diff --git a/src/main/java/de/erethon/dungeonsxl/world/SignData.java b/src/main/java/de/erethon/dungeonsxl/world/SignData.java index 6480372a..b0b043ec 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/SignData.java +++ b/src/main/java/de/erethon/dungeonsxl/world/SignData.java @@ -62,12 +62,9 @@ public class SignData { /* Actions */ /** - * Applies all signs from the file to the DEditWorld. - * Also sets the lobby location of the DEditWorld to the location of the lobby sign if one exists. + * Applies all signs from the file to the DEditWorld. Also sets the lobby location of the DEditWorld to the location of the lobby sign if one exists. * - * @param editWorld - * the DEditWorld where the signs are - * @throws IOException + * @param editWorld the DEditWorld where the signs are */ public void deserializeSigns(DEditWorld editWorld) { try { @@ -100,10 +97,7 @@ public class SignData { /** * Applies all signs from the file to the DGameWorld. * - * @param gameWorld - * the DGameWorld where the signs are - * @return a Set of all DSign blocks - * @throws IOException + * @param gameWorld the DGameWorld where the signs are */ public void deserializeSigns(DGameWorld gameWorld) { try { @@ -132,9 +126,7 @@ public class SignData { /** * Applies all signs from the DEditWorld to the file. * - * @param editWorld - * the DEditWorld that contains the signs to serialize - * @throws IOException + * @param editWorld the DEditWorld that contains the signs to serialize */ public void serializeSigns(DEditWorld editWorld) { serializeSigns(editWorld.getSigns()); @@ -143,9 +135,7 @@ public class SignData { /** * Applies all signs from the sign list to the file. * - * @param signs - * the signs to serialize - * @throws IOException + * @param signs the signs to serialize */ public void serializeSigns(List signs) { try { diff --git a/src/main/java/de/erethon/dungeonsxl/world/WorldConfig.java b/src/main/java/de/erethon/dungeonsxl/world/WorldConfig.java index ad42686d..e646ecc6 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/WorldConfig.java +++ b/src/main/java/de/erethon/dungeonsxl/world/WorldConfig.java @@ -42,9 +42,8 @@ import org.bukkit.configuration.file.YamlConfiguration; import org.bukkit.entity.EntityType; /** - * The world configuration is a simple game rule source. - * Besides game rules, WorldConfig also stores some map specific data such as the invited players. - * It is used directly in dungeon map config.yml files, but also part of dungeon and main config files. + * The world configuration is a simple game rule source. Besides game rules, WorldConfig also stores some map specific data such as the invited players. It is + * used directly in dungeon map config.yml files, but also part of dungeon and main config files. * * @author Frank Baumann, Milan Albrecht, Daniel Saukel */ @@ -372,8 +371,7 @@ public class WorldConfig extends GameRuleProvider { } /** - * @param uuid - * the player's unique ID + * @param uuid the player's unique ID */ public void addInvitedPlayer(String uuid) { if (!invitedPlayers.contains(uuid)) { @@ -382,10 +380,8 @@ public class WorldConfig extends GameRuleProvider { } /** - * @param uuid - * the player's unique ID - * @param name - * the player's name + * @param uuid the player's unique ID + * @param name the player's name */ public void removeInvitedPlayers(String uuid, String name) { invitedPlayers.remove(uuid); @@ -401,8 +397,7 @@ public class WorldConfig extends GameRuleProvider { } /** - * @param forcedGameType - * the forcedGameType to set + * @param forcedGameType the forcedGameType to set */ public void setForcedGameType(GameType forcedGameType) { this.forcedGameType = forcedGameType; @@ -416,8 +411,7 @@ public class WorldConfig extends GameRuleProvider { } /** - * @param worldEnvironment - * the world environment to set + * @param worldEnvironment the world environment to set */ public void setWorldEnvironment(Environment worldEnvironment) { this.worldEnvironment = worldEnvironment; diff --git a/src/main/java/de/erethon/dungeonsxl/world/block/GameBlock.java b/src/main/java/de/erethon/dungeonsxl/world/block/GameBlock.java index 0e8cd118..dab41a96 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/block/GameBlock.java +++ b/src/main/java/de/erethon/dungeonsxl/world/block/GameBlock.java @@ -41,8 +41,7 @@ public abstract class GameBlock { } /** - * @param block - * the block to set + * @param block the block to set */ public void setBlock(Block block) { this.block = block; @@ -52,8 +51,7 @@ public abstract class GameBlock { /** * Handles what happens when a player breaks the block. * - * @param event - * the passed Bukkit event + * @param event the passed Bukkit event * @return if the event is cancelled */ public abstract boolean onBreak(BlockBreakEvent event); diff --git a/src/main/java/de/erethon/dungeonsxl/world/block/MultiBlock.java b/src/main/java/de/erethon/dungeonsxl/world/block/MultiBlock.java index d1d9b28f..91e306b8 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/block/MultiBlock.java +++ b/src/main/java/de/erethon/dungeonsxl/world/block/MultiBlock.java @@ -19,8 +19,7 @@ package de.erethon.dungeonsxl.world.block; import org.bukkit.block.Block; /** - * In some cases, a "game block" might actually be a structure with multiple blocks, - * like a bed or a door with two halfs. These GameBlocks implement MultiBlock. + * In some cases, a "game block" might actually be a structure with multiple blocks, like a bed or a door with two halfs. These GameBlocks implement MultiBlock. * * @author Daniel Saukel */ diff --git a/src/main/java/de/erethon/dungeonsxl/world/block/RewardChest.java b/src/main/java/de/erethon/dungeonsxl/world/block/RewardChest.java index 0408bf83..28079319 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/block/RewardChest.java +++ b/src/main/java/de/erethon/dungeonsxl/world/block/RewardChest.java @@ -73,8 +73,7 @@ public class RewardChest extends GameBlock { } /** - * @param used - * set if the chest is used + * @param used set if the chest is used */ public void setUsed(boolean used) { this.used = used; @@ -88,8 +87,7 @@ public class RewardChest extends GameBlock { } /** - * @param chest - * the chest to set + * @param chest the chest to set */ public void setChest(Chest chest) { this.chest = chest; @@ -103,8 +101,7 @@ public class RewardChest extends GameBlock { } /** - * @param moneyReward - * the moneyReward to set + * @param moneyReward the moneyReward to set */ public void setMoneyReward(double moneyReward) { this.moneyReward = moneyReward; @@ -118,8 +115,7 @@ public class RewardChest extends GameBlock { } /** - * @param levelReward - * the levelReward to set + * @param levelReward the levelReward to set */ public void setLevelReward(int levelReward) { this.levelReward = levelReward; @@ -132,8 +128,7 @@ public class RewardChest extends GameBlock { } /** - * @param opener - * the player who opens the chest + * @param opener the player who opens the chest */ public void onOpen(Player opener) { if (used) { diff --git a/src/main/java/de/erethon/dungeonsxl/world/block/TeamBlock.java b/src/main/java/de/erethon/dungeonsxl/world/block/TeamBlock.java index 6a5f1a2d..0e53a426 100644 --- a/src/main/java/de/erethon/dungeonsxl/world/block/TeamBlock.java +++ b/src/main/java/de/erethon/dungeonsxl/world/block/TeamBlock.java @@ -40,8 +40,7 @@ public abstract class TeamBlock extends GameBlock { } /** - * @param owner - * the owner group to set + * @param owner the owner group to set */ public void setOwner(DGroup owner) { this.owner = owner;