me.realized.duels.api.user

Interface UserManager

public interface UserManager

Represents the UserManager singleton used by Duels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserManager.TopData
static class	UserManager.TopEntry

Method Summary

Modifier and Type	Method and Description
User	get(org.bukkit.entity.Player player) Calls get(UUID) with Entity.getUniqueId().
User	get(java.lang.String name) Gets a User with the given name.
User	get(java.util.UUID uuid) Gets a User with the given UUID.
UserManager.TopEntry	getTopLosses() Gets the top losses.
UserManager.TopEntry	getTopRatings() Gets the top rating for no kit.
UserManager.TopEntry	getTopRatings(Kit kit) Gets the top rating for the given Kit.
UserManager.TopEntry	getTopWins() Gets the top wins.
boolean	isLoaded() Whether or not had all users completed loading to the memory.

Method Detail

isLoaded

boolean isLoaded()

Whether or not had all users completed loading to the memory.

Returns:

True if all users have completed loading to the memory. False otherwise.

get

@Nullable
User get(@Nonnull
                   java.lang.String name)

Gets a User with the given name. Note: If isLoaded() returns false, this may return null even if userdata file exists.

Parameters:

name - Name of the user to get.

Returns:

User with the given name or null if not exists.

get

@Nullable
User get(@Nonnull
                   java.util.UUID uuid)

Gets a User with the given UUID. Note: If isLoaded() returns false, this may return null even if userdata file exists.

Parameters:

uuid - UUID of the user to get.

Returns:

User with the given UUID or null if not exists.

get

@Nullable
User get(@Nonnull
                   org.bukkit.entity.Player player)

Calls get(UUID) with Entity.getUniqueId().

See Also:

get(UUID)

getTopWins

@Nullable
UserManager.TopEntry getTopWins()

Gets the top wins. thread-safe!

Returns:

UserManager.TopEntry containing name and wins of the top 10 Wins or null if the leaderboard has not loaded yet.

getTopLosses

@Nullable
UserManager.TopEntry getTopLosses()

Gets the top losses. thread-safe!

Returns:

UserManager.TopEntry containing name and losses of the top 10 Losses or null if the leaderboard has not loaded yet.

getTopRatings

@Nullable
UserManager.TopEntry getTopRatings()

Gets the top rating for no kit. thread-safe!

Returns:

UserManager.TopEntry containing name and rating of the top 10 Rating for no kit or null if the leaderboard has not loaded yet.

Since:

3.3.0

getTopRatings

@Nullable
UserManager.TopEntry getTopRatings(@Nonnull
                                             Kit kit)

Gets the top rating for the given Kit. thread-safe!

Parameters:

kit - Kit to get UserManager.TopEntry.

Returns:

UserManager.TopEntry containing name and rating of the top 10 Rating for kit or null if the leaderboard has not loaded yet.