From 258e115a3854ac2ebcd6a7ef0fedb6ec375c240e Mon Sep 17 00:00:00 2001 From: Daniel Saukel Date: Fri, 26 Aug 2016 15:42:26 +0200 Subject: [PATCH] Added some JavaDoc explanations to the classes --- .../io/github/dre2n/dungeonsxl/DungeonsXL.java | 3 +++ .../dre2n/dungeonsxl/announcer/Announcer.java | 2 ++ .../dre2n/dungeonsxl/announcer/Announcers.java | 2 ++ .../dungeonsxl/command/DeletePortalCommand.java | 3 ++- .../dre2n/dungeonsxl/config/DMessages.java | 3 +++ .../dre2n/dungeonsxl/config/DungeonConfig.java | 2 ++ .../dre2n/dungeonsxl/config/GlobalData.java | 2 ++ .../dre2n/dungeonsxl/config/MainConfig.java | 2 ++ .../dre2n/dungeonsxl/config/PlayerData.java | 2 ++ .../dre2n/dungeonsxl/config/SignData.java | 2 ++ .../dre2n/dungeonsxl/config/WorldConfig.java | 4 ++++ .../dre2n/dungeonsxl/dungeon/Dungeon.java | 4 ++++ .../dre2n/dungeonsxl/dungeon/Dungeons.java | 2 ++ .../io/github/dre2n/dungeonsxl/game/Game.java | 3 +++ .../github/dre2n/dungeonsxl/game/GameGoal.java | 2 ++ .../github/dre2n/dungeonsxl/game/GameRules.java | 2 ++ .../github/dre2n/dungeonsxl/game/GameType.java | 2 ++ .../dre2n/dungeonsxl/game/GameTypeDefault.java | 2 ++ .../github/dre2n/dungeonsxl/game/GameTypes.java | 2 ++ .../github/dre2n/dungeonsxl/global/DPortal.java | 2 ++ .../dre2n/dungeonsxl/global/GameSign.java | 2 ++ .../dungeonsxl/global/GlobalProtection.java | 17 ++++++++++++++--- .../dungeonsxl/global/GlobalProtections.java | 17 ++++++++++++++--- .../dre2n/dungeonsxl/global/GroupSign.java | 2 ++ .../dre2n/dungeonsxl/global/LeaveSign.java | 2 ++ .../dre2n/dungeonsxl/loottable/DLootTable.java | 2 ++ .../dre2n/dungeonsxl/loottable/DLootTables.java | 2 ++ .../dungeonsxl/mob/CitizensMobProvider.java | 2 ++ .../mob/CustomExternalMobProvider.java | 2 ++ .../dre2n/dungeonsxl/mob/ExternalMobPlugin.java | 2 ++ .../dungeonsxl/mob/ExternalMobProvider.java | 2 ++ .../dungeonsxl/mob/ExternalMobProviders.java | 2 ++ .../github/dre2n/dungeonsxl/player/DClass.java | 2 ++ .../dre2n/dungeonsxl/player/DClasses.java | 2 ++ .../dre2n/dungeonsxl/player/DEditPlayer.java | 2 +- .../dre2n/dungeonsxl/player/DGlobalPlayer.java | 1 - .../github/dre2n/dungeonsxl/player/DGroup.java | 2 ++ .../dungeonsxl/player/DInstancePlayer.java | 2 ++ .../dre2n/dungeonsxl/player/DPlayers.java | 2 ++ .../dungeonsxl/requirement/Requirement.java | 2 ++ .../dungeonsxl/requirement/RequirementType.java | 2 ++ .../requirement/RequirementTypeDefault.java | 2 ++ .../requirement/RequirementTypes.java | 2 ++ .../github/dre2n/dungeonsxl/reward/Reward.java | 2 ++ .../dre2n/dungeonsxl/reward/RewardType.java | 2 ++ .../dungeonsxl/reward/RewardTypeDefault.java | 2 ++ .../dre2n/dungeonsxl/reward/RewardTypes.java | 2 ++ .../io/github/dre2n/dungeonsxl/sign/DSign.java | 4 +++- .../github/dre2n/dungeonsxl/sign/DSignType.java | 2 ++ .../dre2n/dungeonsxl/sign/DSignTypeDefault.java | 2 ++ .../dre2n/dungeonsxl/sign/DSignTypes.java | 2 ++ .../dre2n/dungeonsxl/sign/SignScript.java | 3 +++ .../dre2n/dungeonsxl/sign/SignScripts.java | 2 ++ .../dre2n/dungeonsxl/trigger/Trigger.java | 2 ++ .../dre2n/dungeonsxl/trigger/TriggerType.java | 2 ++ .../dungeonsxl/trigger/TriggerTypeDefault.java | 2 ++ .../dre2n/dungeonsxl/trigger/TriggerTypes.java | 2 ++ .../io/github/dre2n/dungeonsxl/util/DColor.java | 2 ++ .../dre2n/dungeonsxl/util/ProgressBar.java | 2 ++ .../dre2n/dungeonsxl/world/DEditWorld.java | 3 +++ .../dre2n/dungeonsxl/world/DGameWorld.java | 3 +++ .../dre2n/dungeonsxl/world/DInstanceWorld.java | 2 ++ .../github/dre2n/dungeonsxl/world/DWorlds.java | 2 ++ .../dre2n/dungeonsxl/world/block/GameBlock.java | 2 ++ .../dungeonsxl/world/block/LockedDoor.java | 2 ++ 65 files changed, 162 insertions(+), 10 deletions(-) diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/DungeonsXL.java b/core/src/main/java/io/github/dre2n/dungeonsxl/DungeonsXL.java index 56e0111c..6bef52ee 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/DungeonsXL.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/DungeonsXL.java @@ -58,6 +58,9 @@ import org.bukkit.scheduler.BukkitTask; /** + * 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 */ public class DungeonsXL extends BRPlugin { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcer.java b/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcer.java index 576b41d9..80aa9af4 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcer.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcer.java @@ -44,6 +44,8 @@ import org.bukkit.inventory.meta.ItemMeta; /** + * Represents a game announcement. + * * @author Daniel Saukel */ public class Announcer { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcers.java b/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcers.java index 56283e0a..dc0e8c94 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcers.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/announcer/Announcers.java @@ -24,6 +24,8 @@ import org.bukkit.inventory.Inventory; /** + * Announcer instance manager. + * * @author Daniel Saukel */ public class Announcers { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/command/DeletePortalCommand.java b/core/src/main/java/io/github/dre2n/dungeonsxl/command/DeletePortalCommand.java index f58aee22..5818e0be 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/command/DeletePortalCommand.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/command/DeletePortalCommand.java @@ -28,8 +28,9 @@ /** * @author Frank Baumann, Daniel Saukel - * @deprecated + * @deprecated Use BreakCommand instead. */ +@Deprecated public class DeletePortalCommand extends BRCommand { DungeonsXL plugin = DungeonsXL.getInstance(); diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/config/DMessages.java b/core/src/main/java/io/github/dre2n/dungeonsxl/config/DMessages.java index 6d64a2a3..1385c0b3 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/config/DMessages.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/config/DMessages.java @@ -24,6 +24,9 @@ import org.bukkit.configuration.file.YamlConfiguration; /** + * An enumeration of all messages. + * The values are fetched from the language file. + * * @author Daniel Saukel */ public enum DMessages implements Messages { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/config/DungeonConfig.java b/core/src/main/java/io/github/dre2n/dungeonsxl/config/DungeonConfig.java index 8e9bc752..8bae5ca4 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/config/DungeonConfig.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/config/DungeonConfig.java @@ -25,6 +25,8 @@ import java.util.List; /** + * Represents a dungeon script. See {@link io.github.dre2n.dungeonsxl.dungeon.Dungeon}. + * * @author Daniel Saukel */ public class DungeonConfig extends BRConfig { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/config/GlobalData.java b/core/src/main/java/io/github/dre2n/dungeonsxl/config/GlobalData.java index e3b87277..f6870f3a 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/config/GlobalData.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/config/GlobalData.java @@ -20,6 +20,8 @@ import java.io.File; /** + * Represents the global data.yml. + * * @author Daniel Saukel */ public class GlobalData extends BRConfig { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/config/MainConfig.java b/core/src/main/java/io/github/dre2n/dungeonsxl/config/MainConfig.java index f4ecd5ca..57883c00 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/config/MainConfig.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/config/MainConfig.java @@ -32,6 +32,8 @@ import org.bukkit.configuration.ConfigurationSection; /** + * Represents the main config.yml. + * * @author Frank Baumann, Milan Albrecht, Daniel Saukel */ public class MainConfig extends BRConfig { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/config/PlayerData.java b/core/src/main/java/io/github/dre2n/dungeonsxl/config/PlayerData.java index 89a2338a..c0eb556c 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/config/PlayerData.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/config/PlayerData.java @@ -35,6 +35,8 @@ import org.bukkit.potion.PotionEffect; /** + * Represents a player's persistent data. + * * @author Daniel Saukel */ public class PlayerData extends BRConfig { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/config/SignData.java b/core/src/main/java/io/github/dre2n/dungeonsxl/config/SignData.java index 7032840b..733a2307 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/config/SignData.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/config/SignData.java @@ -30,6 +30,8 @@ import org.bukkit.block.Sign; /** + * Represents the data file of a dungeon map, mainly to store signs. + * * @author Daniel Saukel */ public class SignData { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/config/WorldConfig.java b/core/src/main/java/io/github/dre2n/dungeonsxl/config/WorldConfig.java index a4cce5be..0020635a 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/config/WorldConfig.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/config/WorldConfig.java @@ -44,6 +44,10 @@ import org.bukkit.inventory.ItemStack; /** + * 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 */ public class WorldConfig extends GameRules { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeon.java b/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeon.java index 4fbcc2fd..9458eb66 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeon.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeon.java @@ -21,6 +21,10 @@ import java.io.File; /** + * Represents a dungeon. + * While multi floor dungeon scripts are represented by {@link io.github.dre2n.dungeonsxl.config.DungeonConfig}, + * single floor dungeons also get a dungeon object without a config file as a placeholder. + * * @author Daniel Saukel */ public class Dungeon { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeons.java b/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeons.java index 2f5f8c13..673285d0 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeons.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/dungeon/Dungeons.java @@ -22,6 +22,8 @@ import java.util.List; /** + * Dungeon instance manager. + * * @author Daniel Saukel */ public class Dungeons { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/game/Game.java b/core/src/main/java/io/github/dre2n/dungeonsxl/game/Game.java index ff5cf419..4cd57a54 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/game/Game.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/game/Game.java @@ -41,6 +41,9 @@ import org.bukkit.scheduler.BukkitRunnable; /** + * Game mostly stores for which purposes and how a {@link io.github.dre2n.dungeonsxl.dungeon.Dungeon} is used, + * the player groups and the progress. + * * @author Daniel Saukel */ public class Game { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameGoal.java b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameGoal.java index ea6ed595..dc50fce3 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameGoal.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameGoal.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.game; /** + * A game goal defines what the players have to do in order to finish the game. + * * @author Daniel Saukel */ public enum GameGoal { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameRules.java b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameRules.java index 98007a72..0cd6e350 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameRules.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameRules.java @@ -29,6 +29,8 @@ import org.bukkit.inventory.ItemStack; /** + * See {@link io.github.dre2n.dungeonsxl.config.WorldConfig} + * * @author Daniel Saukel */ public class GameRules { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameType.java b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameType.java index 3cc32577..460d404d 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameType.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameType.java @@ -19,6 +19,8 @@ import org.bukkit.GameMode; /** + * Implement this to create custom game types. + * * @author Daniel Saukel */ public interface GameType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypeDefault.java b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypeDefault.java index abf3f1b9..7bd94403 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypeDefault.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypeDefault.java @@ -20,6 +20,8 @@ import org.bukkit.GameMode; /** + * Default implementation of {@link io.github.dre2n.dungeonsxl.game.GameType}. + * * @author Daniel Saukel */ public enum GameTypeDefault implements GameType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypes.java b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypes.java index a754b1d7..7590eef5 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypes.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/game/GameTypes.java @@ -22,6 +22,8 @@ import java.util.List; /** + * GameType instance manager. + * * @author Daniel Saukel */ public class GameTypes { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/global/DPortal.java b/core/src/main/java/io/github/dre2n/dungeonsxl/global/DPortal.java index a70adbb8..5dab6fd2 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/global/DPortal.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/global/DPortal.java @@ -35,6 +35,8 @@ import org.bukkit.entity.Player; /** + * A portal that leads into a dungeon. + * * @author Frank Baumann, Daniel Saukel */ public class DPortal extends GlobalProtection { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GameSign.java b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GameSign.java index f8adbdbb..3f98e3c3 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GameSign.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GameSign.java @@ -34,6 +34,8 @@ import org.bukkit.entity.Player; /** + * Basically a GroupSign, but to form a game of multiple groups. + * * @author Frank Baumann, Milan Albrecht, Daniel Saukel */ public class GameSign extends GlobalProtection { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtection.java b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtection.java index e081bcbd..6b83c1cd 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtection.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtection.java @@ -1,7 +1,18 @@ /* - * To change this license header, choose License Headers in Project Properties. - * To change this template file, choose Tools | Templates - * and open the template in the editor. + * Copyright (C) 2012-2016 Frank Baumann + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ package io.github.dre2n.dungeonsxl.global; diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtections.java b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtections.java index 784cec84..a0f97a51 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtections.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GlobalProtections.java @@ -1,7 +1,18 @@ /* - * To change this license header, choose License Headers in Project Properties. - * To change this template file, choose Tools | Templates - * and open the template in the editor. + * Copyright (C) 2012-2016 Frank Baumann + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . */ package io.github.dre2n.dungeonsxl.global; diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GroupSign.java b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GroupSign.java index a432c283..f0630ce5 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/global/GroupSign.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/global/GroupSign.java @@ -33,6 +33,8 @@ import org.bukkit.entity.Player; /** + * A sign to form a group and to define its dungeon. + * * @author Frank Baumann, Milan Albrecht, Daniel Saukel */ public class GroupSign extends GlobalProtection { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/global/LeaveSign.java b/core/src/main/java/io/github/dre2n/dungeonsxl/global/LeaveSign.java index f3cd41b7..2f0e38f8 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/global/LeaveSign.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/global/LeaveSign.java @@ -30,6 +30,8 @@ import org.bukkit.entity.Player; /** + * A sign to leave a group. + * * @author Frank Baumann */ public class LeaveSign extends GlobalProtection { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTable.java b/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTable.java index c8ba5201..4999cf9d 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTable.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTable.java @@ -26,6 +26,8 @@ import org.bukkit.inventory.ItemStack; /** + * A loot table for rewards and mob drops. + * * @author Daniel Saukel */ public class DLootTable { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTables.java b/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTables.java index ce6b412f..aa4499fa 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTables.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/loottable/DLootTables.java @@ -22,6 +22,8 @@ import java.util.List; /** + * DLootTable instance manager. + * * @author Daniel Saukel */ public class DLootTables { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CitizensMobProvider.java b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CitizensMobProvider.java index 2ab4d8ba..6f2b4cdd 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CitizensMobProvider.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CitizensMobProvider.java @@ -26,6 +26,8 @@ import org.bukkit.entity.LivingEntity; /** + * ExternalMobProvider implementation for Citizens. + * * @author Daniel Saukel */ public class CitizensMobProvider implements ExternalMobProvider { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CustomExternalMobProvider.java b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CustomExternalMobProvider.java index 420c4733..4bfe7b7a 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CustomExternalMobProvider.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/CustomExternalMobProvider.java @@ -21,6 +21,8 @@ import org.bukkit.Location; /** + * A custom external mob provider like defined in the main config file. + * * @author Daniel Saukel */ public class CustomExternalMobProvider implements ExternalMobProvider { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobPlugin.java b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobPlugin.java index dc4d2b24..6457f656 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobPlugin.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobPlugin.java @@ -20,6 +20,8 @@ import org.bukkit.Location; /** + * Officially supported external mob plugins. + * * @author Daniel Saukel */ public enum ExternalMobPlugin implements ExternalMobProvider { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProvider.java b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProvider.java index 395bed8a..20774aed 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProvider.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProvider.java @@ -19,6 +19,8 @@ import org.bukkit.Location; /** + * Implement this to create custom ExternalMobProviders. + * * @author Daniel Saukel */ public interface ExternalMobProvider { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProviders.java b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProviders.java index 8d5834b2..c0467396 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProviders.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/mob/ExternalMobProviders.java @@ -25,6 +25,8 @@ import org.bukkit.Bukkit; /** + * ExternalMobProvider instance manager. + * * @author Daniel Saukel */ public class ExternalMobProviders { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClass.java b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClass.java index 79b2e1c2..2a3d07b0 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClass.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClass.java @@ -29,6 +29,8 @@ import org.bukkit.inventory.ItemStack; /** + * Represents a class and a class script. + * * @author Frank Baumann, Daniel Saukel */ public class DClass { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClasses.java b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClasses.java index 1de12c19..579e9652 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClasses.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DClasses.java @@ -22,6 +22,8 @@ import java.util.List; /** + * DClass instance manager. + * * @author Daniel Saukel */ public class DClasses { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DEditPlayer.java b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DEditPlayer.java index ea411981..4a891df1 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DEditPlayer.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DEditPlayer.java @@ -33,7 +33,7 @@ import org.bukkit.event.block.SignChangeEvent; /** - * Represents a player in an DEditWorld. + * Represents a player in a DEditWorld. * * @author Daniel Saukel */ diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGlobalPlayer.java b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGlobalPlayer.java index 46827004..21b4adf4 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGlobalPlayer.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGlobalPlayer.java @@ -34,7 +34,6 @@ import org.bukkit.entity.Player; import org.bukkit.inventory.ItemStack; import org.bukkit.potion.PotionEffect; -import org.bukkit.scheduler.BukkitRunnable; /** * Represents a player in the non-DXL worlds of the server. diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGroup.java b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGroup.java index cbc5ac2f..8a73c1a1 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGroup.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DGroup.java @@ -44,6 +44,8 @@ import org.bukkit.scheduler.BukkitTask; /** + * Represents a group of players. + * * @author Frank Baumann, Daniel Saukel */ public class DGroup { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DInstancePlayer.java b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DInstancePlayer.java index 0c9ee584..22e4e5f4 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DInstancePlayer.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DInstancePlayer.java @@ -21,6 +21,8 @@ import org.bukkit.potion.PotionEffect; /** + * Represents a player in an instance. + * * @author Daniel Saukel */ public abstract class DInstancePlayer extends DGlobalPlayer { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DPlayers.java b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DPlayers.java index 8b7cea22..61dca293 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/player/DPlayers.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/player/DPlayers.java @@ -23,6 +23,8 @@ import org.bukkit.entity.Player; /** + * DGlobalPlayer instance manager. + * * @author Daniel Saukel */ public class DPlayers { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/Requirement.java b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/Requirement.java index 7ef734ee..03f9fc4d 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/Requirement.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/Requirement.java @@ -26,6 +26,8 @@ import org.bukkit.entity.Player; /** + * Extend this to create a custom Requirement. + * * @author Daniel Saukel */ public abstract class Requirement { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementType.java b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementType.java index 58673f0f..afa07d63 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementType.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementType.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.requirement; /** + * Implement this to create custom requirement types. + * * @author Daniel Saukel */ public interface RequirementType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypeDefault.java b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypeDefault.java index c4a3a4e0..1a9520b5 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypeDefault.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypeDefault.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.requirement; /** + * Default implementation of RequirementType. + * * @author Daniel Saukel */ public enum RequirementTypeDefault implements RequirementType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypes.java b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypes.java index af0fd890..541b2731 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypes.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/requirement/RequirementTypes.java @@ -21,6 +21,8 @@ import java.util.List; /** + * RequirementType instance manager. + * * @author Daniel Saukel */ public class RequirementTypes { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/Reward.java b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/Reward.java index 3e785ebd..74380ed3 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/Reward.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/Reward.java @@ -25,6 +25,8 @@ import org.bukkit.entity.Player; /** + * Extend this to create a custom Reward. + * * @author Daniel Saukel */ public abstract class Reward { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardType.java b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardType.java index e1276978..58e26927 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardType.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardType.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.reward; /** + * Implement this to create custom reward types. + * * @author Daniel Saukel */ public interface RewardType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypeDefault.java b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypeDefault.java index adccf29a..c29b719d 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypeDefault.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypeDefault.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.reward; /** + * Default implementation of RewardType. + * * @author Daniel Saukel */ public enum RewardTypeDefault implements RewardType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypes.java b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypes.java index 82bb20e1..c06062de 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypes.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/reward/RewardTypes.java @@ -21,6 +21,8 @@ import java.util.List; /** + * RewardType instance manager. + * * @author Daniel Saukel */ public class RewardTypes { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSign.java b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSign.java index 39cd1d50..4e26e06e 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSign.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSign.java @@ -32,6 +32,8 @@ import org.bukkit.entity.Player; /** + * Extend this to create a custom DSign. + * * @author Frank Baumann, Milan Albrecht, Daniel Saukel */ public abstract class DSign { @@ -203,7 +205,7 @@ public void markAsErroneous() { sign.setLine(2, ERROR_2); sign.setLine(3, ERROR_3); sign.update(); - + DMessages.LOG_ERROR_SIGN_SETUP.getMessage(sign.getX() + ", " + sign.getY() + ", " + sign.getZ()); } diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignType.java b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignType.java index fb5e19de..d081149e 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignType.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignType.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.sign; /** + * Implement this to create custom sign types. + * * @author Daniel Saukel */ public interface DSignType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypeDefault.java b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypeDefault.java index 4690b7ea..8910f494 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypeDefault.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypeDefault.java @@ -19,6 +19,8 @@ import io.github.dre2n.dungeonsxl.player.DPermissions; /** + * Default implementation of DSignType. + * * @author Daniel Saukel */ public enum DSignTypeDefault implements DSignType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypes.java b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypes.java index ba1fe6ef..f8ee3b23 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypes.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/DSignTypes.java @@ -21,6 +21,8 @@ import java.util.List; /** + * DSignType instance manager. + * * @author Daniel Saukel */ public class DSignTypes { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScript.java b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScript.java index bed6f0f8..41b0cdd0 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScript.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScript.java @@ -25,6 +25,9 @@ import org.bukkit.configuration.file.YamlConfiguration; /** + * Representation of a sign script. + * Sign scripts allow to merge multiple dungeon signs at one position. + * * @author Daniel Saukel */ public class SignScript { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScripts.java b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScripts.java index ddb1b237..36088dce 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScripts.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/sign/SignScripts.java @@ -22,6 +22,8 @@ import java.util.List; /** + * SignScript instance manager. + * * @author Daniel Saukel */ public class SignScripts { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/Trigger.java b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/Trigger.java index ab912406..18ac75e8 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/Trigger.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/Trigger.java @@ -29,6 +29,8 @@ import org.bukkit.entity.Player; /** + * Extend this to create a custom Trigger. + * * @author Frank Baumann, Daniel Saukel */ public abstract class Trigger { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerType.java b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerType.java index f869087e..418ceb30 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerType.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerType.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.trigger; /** + * Implement this to create custom trigger types. + * * @author Daniel Saukel */ public interface TriggerType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypeDefault.java b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypeDefault.java index b461cde6..ea13685f 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypeDefault.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypeDefault.java @@ -17,6 +17,8 @@ package io.github.dre2n.dungeonsxl.trigger; /** + * Default implementation of TriggerType. + * * @author Daniel Saukel */ public enum TriggerTypeDefault implements TriggerType { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypes.java b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypes.java index 965ac63b..76c524ff 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypes.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/trigger/TriggerTypes.java @@ -21,6 +21,8 @@ import java.util.List; /** + * TriggerType instance manager. + * * @author Daniel Saukel */ public class TriggerTypes { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/util/DColor.java b/core/src/main/java/io/github/dre2n/dungeonsxl/util/DColor.java index b9aef48f..63f9d315 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/util/DColor.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/util/DColor.java @@ -20,6 +20,8 @@ import org.bukkit.DyeColor; /** + * Links different color types together. + * * @author Daniel Saukel */ public enum DColor { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/util/ProgressBar.java b/core/src/main/java/io/github/dre2n/dungeonsxl/util/ProgressBar.java index 3e2d4867..93d62940 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/util/ProgressBar.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/util/ProgressBar.java @@ -28,6 +28,8 @@ import org.bukkit.scheduler.BukkitTask; /** + * A boss bar based progress bar. + * * @author Daniel Saukel */ public class ProgressBar extends BukkitRunnable { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DEditWorld.java b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DEditWorld.java index 7fe6b91f..203daa65 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DEditWorld.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DEditWorld.java @@ -31,6 +31,9 @@ import org.bukkit.scheduler.BukkitRunnable; /** + * A raw resource world instance to edit the dungeon map. + * There is never more than one DEditWorld per DResourceWorld. + * * @author Frank Baumann, Daniel Saukel */ public class DEditWorld extends DInstanceWorld { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DGameWorld.java b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DGameWorld.java index 84055591..c85ed7e6 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DGameWorld.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DGameWorld.java @@ -66,6 +66,9 @@ import org.bukkit.scheduler.BukkitRunnable; /** + * A playable resource instance. + * There may be any amount of DGameWorlds per DResourceWorld. + * * @author Frank Baumann, Milan Albrecht, Daniel Saukel */ public class DGameWorld extends DInstanceWorld { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DInstanceWorld.java b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DInstanceWorld.java index 84e4ac5a..3f10c676 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DInstanceWorld.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DInstanceWorld.java @@ -25,6 +25,8 @@ import org.bukkit.World; /** + * An instance of a resource world. + * * @author Daniel Saukel */ public abstract class DInstanceWorld { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DWorlds.java b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DWorlds.java index d8dba9ff..9529f57c 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/world/DWorlds.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/world/DWorlds.java @@ -30,6 +30,8 @@ import org.bukkit.WorldType; /** + * World instance manager. + * * @author Daniel Saukel */ public class DWorlds { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/GameBlock.java b/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/GameBlock.java index 307d7244..dfa65656 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/GameBlock.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/GameBlock.java @@ -20,6 +20,8 @@ import org.bukkit.event.block.BlockBreakEvent; /** + * A block that has a special purpose in a game. + * * @author Daniel Saukel */ public abstract class GameBlock { diff --git a/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/LockedDoor.java b/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/LockedDoor.java index 547e95de..4bbaca58 100644 --- a/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/LockedDoor.java +++ b/core/src/main/java/io/github/dre2n/dungeonsxl/world/block/LockedDoor.java @@ -21,6 +21,8 @@ import org.bukkit.event.block.BlockBreakEvent; /** + * A locked door that may be opened with a trigger. + * * @author Daniel Saukel */ public class LockedDoor extends GameBlock implements MultiBlock {