Added MCPlayer#getName

xDec0de · Sep 7, 2024 · 30330aa · 30330aa
1 parent 59cb221
commit 30330aa
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/platforms/spigot/src/main/java/net/codersky/mcutils/spigot/player/SpigotPlayer.java b/platforms/spigot/src/main/java/net/codersky/mcutils/spigot/player/SpigotPlayer.java
@@ -33,6 +33,12 @@ public UUID getUniqueId() {
 		return handle.getUniqueId();
 	}
 
+	@NotNull
+	@Override
+	public String getName() {
+		return handle.getName();
+	}
+
 	/*
 	 * MessageReceiver implementation
 	 */

diff --git a/platforms/velocity/src/main/java/net/codersky/mcutils/velocity/player/VelocityPlayer.java b/platforms/velocity/src/main/java/net/codersky/mcutils/velocity/player/VelocityPlayer.java
@@ -32,6 +32,12 @@ public UUID getUniqueId() {
 		return handle.getUniqueId();
 	}
 
+	@NotNull
+	@Override
+	public String getName() {
+		return handle.getUsername();
+	}
+
 	/*
 	 * MessageReceiver implementation
 	 */

diff --git a/shared/src/main/java/net/codersky/mcutils/crossplatform/player/MCPlayer.java b/shared/src/main/java/net/codersky/mcutils/crossplatform/player/MCPlayer.java
@@ -39,4 +39,18 @@ public interface MCPlayer<T> extends MessageReceiver {
 	 */
 	@NotNull
 	UUID getUniqueId();
+
+	/**
+	 * Gets the name of this {@link MCPlayer}. Keep in mind that player
+	 * names may change at any given time and should not be used
+	 * for storage. {@link #getUniqueId() UUIDs} can be used for that purpose
+	 * instead, names are only guaranteed to remain unchanged for a single session
+	 * (Until the player logs out).
+	 *
+	 * @return The name of this {@link MCPlayer}.
+	 *
+	 * @since MCUtils 1.0.0
+	 */
+	@NotNull
+	String getName();
 }