Add some API / implementation difference notes

This commit is contained in:
Daniel Saukel 2020-01-24 17:27:19 +01:00
parent 7e2153f532
commit ab845b8557
5 changed files with 8 additions and 0 deletions

View File

@ -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 {
/**

View File

@ -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 {
/**

View File

@ -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
*/

View File

@ -23,6 +23,7 @@ import org.bukkit.World;
*
* @author Daniel Saukel
*/
// Implementation-specific methods: setWorld, clearPlayerData, delete, chat, update
public interface InstancePlayer extends GlobalPlayer {
/**

View File

@ -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 {
/**