Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2024-12-26 19:07:40 +01:00
Code Issues Projects Releases Wiki Activity

Add OfflinePlayer#isConnected

Browse Source 
This adds an alternative to OfflinePlayer#isOnline that returns true only if the same instance of the player is still online. This is generally more useful than isOnline as it allows you to determine if you have an instance of a Player that still exists. If a player relogs an old Player instance becomes unlinked leading to e.g. messages sent to the old player no longer arriving despite isOnline returning true. Checking against isConnected is more useful there to discard invalid instances.
This commit is contained in:
Aeltumn 2023-08-24 13:05:07 +02:00
parent 4b46a36a94
commit 71fdafca71
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
paper-api/src/main/java/org/bukkit/OfflinePlayer.java
View File

@ -24,10 +24,26 @@ public interface OfflinePlayer extends ServerOperator, AnimalTamer, Configuratio
/**
* Checks if this player is currently online
*
* It should be noted that this will return true if any instance of this player is
* online! This instance may have disconnected. If you wish to check if this specific
* instance of the player is still online, see {@link OfflinePlayer#isConnected()}.
*
* @return true if they are online
*/
public boolean isOnline();
// Paper start
/**
* Checks whether the connection to this player is still valid. This will return
* true as long as this specific instance of the player is still connected. This
* will return false after this instance has disconnected, even if the same player
* has reconnected since.
*
* @return true if this player instance is connected
*/
public boolean isConnected();
// Paper end
/**
* Returns the name of this player
* <p>