Package com.plotsquared.core.util
Class PlayerManager<P extends PlotPlayer<? extends T>,T>
java.lang.Object
com.plotsquared.core.util.PlayerManager<P,T>
Manages player instances
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreatePlayer
(@NonNull UUID uuid) Deprecated, for removal: This API element is subject to removal in a future version.Deprecated, for removal: This API element is subject to removal in a future version.abstract @Nullable OfflinePlotPlayer
getOfflinePlayer
(@NonNull String username) Get an offline player object from the player's usernameabstract @Nullable OfflinePlotPlayer
getOfflinePlayer
(@Nullable UUID uuid) Get an an offline player object from the player's UUIDGet a plot player from a UUID.Get a plot player from a platform player object.getPlayerIfExists
(@Nullable String name) getPlayerIfExists
(@Nullable UUID uuid) Get the player from its UUID if it is stored in the player map.getPlayerList
(@NonNull Collection<UUID> uuids, LocaleHolder localeHolder) Get a list of names given a list of UUIDs.Get all online playersstatic void
getUUIDsFromString
(@NonNull String list, @NonNull BiConsumer<Collection<UUID>, Throwable> consumer) void
removePlayer
(@NonNull PlotPlayer<?> plotPlayer) Remove a player from the player mapvoid
removePlayer
(@NonNull UUID uuid) Remove a player from the player mapresolveName
(@Nullable UUID owner) Attempts to resolve the username by an uuidresolveName
(@Nullable UUID owner, boolean blocking) Attempts to resolve the username by an uuid
-
Constructor Details
-
PlayerManager
public PlayerManager()
-
-
Method Details
-
getUUIDsFromString
public static void getUUIDsFromString(@NonNull String list, @NonNull BiConsumer<Collection<UUID>, Throwable> consumer) -
getPlayerList
public static @NonNull Component getPlayerList(@NonNull Collection<UUID> uuids, LocaleHolder localeHolder) Get a list of names given a list of UUIDs. - Uses the formatTranslatableCaption.of(String)
of "info.plot_user_list" for the returned string- Parameters:
uuids
- UUIDslocaleHolder
- the localeHolder to localize the component for- Returns:
- Component of name list
-
getName
@Deprecated(forRemoval=true, since="6.4.0") public static @NonNull String getName(@Nullable UUID owner) Deprecated, for removal: This API element is subject to removal in a future version.Get the name from a UUID.- Parameters:
owner
- Owner UUID- Returns:
- The player's name, None, Everyone or Unknown
-
getName
@Deprecated(forRemoval=true, since="6.4.0") public static @NonNull String getName(@Nullable UUID owner, boolean blocking) Deprecated, for removal: This API element is subject to removal in a future version.Get the name from a UUID.- Parameters:
owner
- Owner UUIDblocking
- Whether or not the operation can be blocking- Returns:
- The player's name, None, Everyone or Unknown
-
resolveName
Attempts to resolve the username by an uuidNote: blocks the thread until the name was resolved or failed
- Parameters:
owner
- The UUID of the owner- Returns:
- A caption containing either the name,
None
,Everyone
orUnknown
- Since:
- 6.4.0
- See Also:
-
resolveName
Attempts to resolve the username by an uuid- Parameters:
owner
- The UUID of the ownerblocking
- If the operation should block the current thread forSettings.UUID.BLOCKING_TIMEOUT
milliseconds- Returns:
- A caption containing either the name,
None
,Everyone
orUnknown
- Since:
- 6.4.0
-
removePlayer
Remove a player from the player map- Parameters:
plotPlayer
- Player to remove
-
removePlayer
Remove a player from the player map- Parameters:
uuid
- Player to remove
-
getPlayerIfExists
Get the player from its UUID if it is stored in the player map.- Parameters:
uuid
- Player UUID- Returns:
- Player, or null
-
getPlayerIfExists
-
getPlayer
Get a plot player from a platform player object. This method requires that the caller actually knows that the player exists and is online.The method will throw an exception if there is no such player online.
- Parameters:
object
- Platform player object- Returns:
- Player object
-
getPlayer
Get a plot player from a UUID. This method requires that the caller actually knows that the player exists.The method will throw an exception if there is no such player online.
- Parameters:
uuid
- Player UUID- Returns:
- Player object
-
createPlayer
-
getOfflinePlayer
Get an an offline player object from the player's UUID- Parameters:
uuid
- Player UUID- Returns:
- Offline player object
-
getOfflinePlayer
Get an offline player object from the player's username- Parameters:
username
- Player name- Returns:
- Offline player object
-
getPlayers
Get all online players- Returns:
- Unmodifiable collection of players
-
resolveName(UUID)