From ab845b855738d3323f61471aa67d082770e6b29b Mon Sep 17 00:00:00 2001
From: Daniel Saukel <sa.da@unitybox.de>
Date: Fri, 24 Jan 2020 17:27:19 +0100
Subject: [PATCH] Add some API / implementation difference notes

---
 .../main/java/de/erethon/dungeonsxl/api/player/EditPlayer.java | 1 +
 .../main/java/de/erethon/dungeonsxl/api/player/GamePlayer.java | 1 +
 .../java/de/erethon/dungeonsxl/api/player/GlobalPlayer.java    | 3 +++
 .../java/de/erethon/dungeonsxl/api/player/InstancePlayer.java  | 1 +
 .../java/de/erethon/dungeonsxl/api/player/PlayerGroup.java     | 2 ++
 5 files changed, 8 insertions(+)

diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/player/EditPlayer.java b/api/src/main/java/de/erethon/dungeonsxl/api/player/EditPlayer.java
index a7972c87..f64abb61 100644
--- a/api/src/main/java/de/erethon/dungeonsxl/api/player/EditPlayer.java
+++ b/api/src/main/java/de/erethon/dungeonsxl/api/player/EditPlayer.java
@@ -23,6 +23,7 @@ import de.erethon.dungeonsxl.api.world.EditWorld;
  *
  * @author Daniel Saukel
  */
+// Implementation-specific methods: g/s lines copy, poke
 public interface EditPlayer extends InstancePlayer {
 
     /**
diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/player/GamePlayer.java b/api/src/main/java/de/erethon/dungeonsxl/api/player/GamePlayer.java
index 1108aceb..61b350a5 100644
--- a/api/src/main/java/de/erethon/dungeonsxl/api/player/GamePlayer.java
+++ b/api/src/main/java/de/erethon/dungeonsxl/api/player/GamePlayer.java
@@ -23,6 +23,7 @@ import org.bukkit.Location;
  *
  * @author Daniel Saukel
  */
+// Implementation-specific methods: isInTestMode, setReady, [wolf, group tag, requirement, loot check methods], finishFloor
 public interface GamePlayer extends InstancePlayer {
 
     /**
diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/player/GlobalPlayer.java b/api/src/main/java/de/erethon/dungeonsxl/api/player/GlobalPlayer.java
index d17c4aa0..6718415a 100644
--- a/api/src/main/java/de/erethon/dungeonsxl/api/player/GlobalPlayer.java
+++ b/api/src/main/java/de/erethon/dungeonsxl/api/player/GlobalPlayer.java
@@ -27,6 +27,7 @@ import org.bukkit.inventory.ItemStack;
  *
  * @author Daniel Saukel
  */
+// Implementation-specific methods: getters and setters: data, portal, cached item, announcer, reward items; startTutorial
 public interface GlobalPlayer extends PlayerWrapper {
 
     /**
@@ -104,6 +105,8 @@ public interface GlobalPlayer extends PlayerWrapper {
 
     /**
      * Sends a message to the player.
+     * <p>
+     * Supports color codes.
      *
      * @param message the message to send
      */
diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/player/InstancePlayer.java b/api/src/main/java/de/erethon/dungeonsxl/api/player/InstancePlayer.java
index 01dc60ef..4811fbf7 100644
--- a/api/src/main/java/de/erethon/dungeonsxl/api/player/InstancePlayer.java
+++ b/api/src/main/java/de/erethon/dungeonsxl/api/player/InstancePlayer.java
@@ -23,6 +23,7 @@ import org.bukkit.World;
  *
  * @author Daniel Saukel
  */
+// Implementation-specific methods: setWorld, clearPlayerData, delete, chat, update
 public interface InstancePlayer extends GlobalPlayer {
 
     /**
diff --git a/api/src/main/java/de/erethon/dungeonsxl/api/player/PlayerGroup.java b/api/src/main/java/de/erethon/dungeonsxl/api/player/PlayerGroup.java
index e034176e..f415baf3 100644
--- a/api/src/main/java/de/erethon/dungeonsxl/api/player/PlayerGroup.java
+++ b/api/src/main/java/de/erethon/dungeonsxl/api/player/PlayerGroup.java
@@ -29,6 +29,8 @@ import org.bukkit.entity.Player;
  *
  * @author Daniel Saukel
  */
+// Implementation-specific methods: setDungeon, setPlaying, [color, unplayed floor, floor count, reward methods], isEmpty, isCustom, isFinished, teleport,
+// finish, finishFloor, startGame, winGame, requirements methods
 public interface PlayerGroup {
 
     /**