#1041: Improve getPlayer(String) docs to clarify it matches the name

This commit is contained in:
Phoenix616 2024-07-03 20:30:38 +10:00 committed by md_5
parent 9738f00514
commit e86f4dc4bb
No known key found for this signature in database
GPG key ID: E8E901AC7C617C11
2 changed files with 8 additions and 2 deletions

View file

@ -633,7 +633,10 @@ public final class Bukkit {
} }
/** /**
* Gets a player object by the given username. * Gets a player whose name matches the given name closest.
* <p>
* Use {@link #getPlayerExact(String)} to get the player matching the input exactly
* and {@link #matchPlayer(String)} if you want a list of all players matching the input.
* <p> * <p>
* This method may not return objects for offline players. * This method may not return objects for offline players.
* *

View file

@ -544,7 +544,10 @@ public interface Server extends PluginMessageRecipient {
public int getTicksPerSpawns(@NotNull SpawnCategory spawnCategory); public int getTicksPerSpawns(@NotNull SpawnCategory spawnCategory);
/** /**
* Gets a player object by the given username. * Gets a player whose name matches the given name closest.
* <p>
* Use {@link #getPlayerExact(String)} to get the player matching the input exactly
* and {@link #matchPlayer(String)} if you want a list of all players matching the input.
* <p> * <p>
* This method may not return objects for offline players. * This method may not return objects for offline players.
* *