doc

core-lib/src/main/java/de/kentoj/scrowlib/player/NetworkPlayer.java

@@ -2,6 +2,21 @@ package de.kentoj.scrowlib.player;
 
 import net.kyori.adventure.audience.Audience;
 
+/**
+ * All methods here are NON-blocking.
+ * NetworkPlayer represents a Player that MAY be online on any of the minecraft, wrapped
+ * in an {@link Audience}
+ * servers in the network.
+ *
+ * If the player is not online, these methods DO NOTHING.
+ * Most methods here do nothing even if the Player is valid(as is the nature of Audiences)
+ * 
+ * this interface should be used mainly for communication(e.g sending messages, playing sounds, ...).
+ * For more complex operations, use the {@link MessageBroker}.
+ *
+ * @see {@link NetworkPlayerImpl}
+ * @see {@link MessageBroker}
+ */
 public interface NetworkPlayer extends Audience {
 
     void sendToInstance(String handle);