me.realized.duels.api.arena

Interface ArenaManager

public interface ArenaManager

Represents the ArenaManager singleton used by Duels.

Method Summary

Modifier and Type	Method and Description
Arena	get(org.bukkit.entity.Player player) Attempts to find an Arena instance that contains the player.
Arena	get(java.lang.String name) Attempts to find an Arena instance associated with the given name.
java.util.List<Arena>	getArenas() An UnmodifiableList of Arenas that are currently loaded.
boolean	isInMatch(org.bukkit.entity.Player player) Whether or not the given player is in a match.

Method Detail

get

@Nullable
Arena get(@NotNull
                    java.lang.String name)

Attempts to find an Arena instance associated with the given name.

Parameters:

name - Name to search through the loaded arenas. Should not be null!

Returns:

Arena instance that has a name matching with the given name or null if not exists.

get

@Nullable
Arena get(@NotNull
                    org.bukkit.entity.Player player)

Attempts to find an Arena instance that contains the player.

Parameters:

player - Player to search through the loaded arenas. Should not be null!

Returns:

Arena instance that contains the player or null if not exists.

isInMatch

boolean isInMatch(@NotNull
                  org.bukkit.entity.Player player)

Whether or not the given player is in a match. If returned true, get(Player) is guaranteed to return a Arena instance.

Parameters:

player - Player to check if in match. Should not be null!

Returns:

True if player was in a match. False otherwise.

getArenas

@NotNull
java.util.List<Arena> getArenas()

An UnmodifiableList of Arenas that are currently loaded.

Returns:

Never-null UnmodifiableList of Arenas that are currently loaded.

Since:

3.4.0