Package de.marcely.bedwars.api.arena.picker.condition.variable

Enum ArenaConditionVariableType

java.lang.Object

java.lang.Enum<ArenaConditionVariableType>

de.marcely.bedwars.api.arena.picker.condition.variable.ArenaConditionVariableType

All Implemented Interfaces:

Serializable, Comparable<ArenaConditionVariableType>, java.lang.constant.Constable

public enum ArenaConditionVariableType
extends Enum<ArenaConditionVariableType>

A type of the variable. Differentiate between default and custom ones.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLONED_ARENA_NAME	Gets the name of the arena from which it has been cloned.
CUSTOM_MODE	Gets the name of the custom mode, or an empty string when none is set
DISPLAY_NAME	Arena.getDisplayName()
GAME_WORLD	Arena.getGameWorldName()
INGAME_PLAYERS	Amount of Arena.getPlayers()
MAX_PLAYERS	Arena.getMaxPlayers()
MIN_PLAYERS	Arena.getMinPlayers()
NAME	Arena.getName()
PLAYERS_PER_TEAM	Arena.getPlayersPerTeam()
PLUGIN	Custom type
REMAINING_SLOTS	Amount until Arena.getMaxPlayers() is reached
SERVER_CHANNEL_NAME	If the arena is local: Plugin tries to fetch the BungeeCord channel name and returns that one.
SERVER_PLAYING_ARENAS_COUNT	Gets the amount of arenas on the server of the testing arena that has at least 1 player
STATUS	Legacy id of Arena.getStatus()
TEAMS	Amount of Arena.getEnabledTeams()
TYPE	Arena.getRegenerationType()

Method Summary

Modifier and Type	Method	Description
@Nullable ArenaConditionVariable<?>	getInstance()	Returns the effective instance of this type.
static ArenaConditionVariableType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ArenaConditionVariableType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLAYERS_PER_TEAM

public static final ArenaConditionVariableType PLAYERS_PER_TEAM

Arena.getPlayersPerTeam()

TEAMS

public static final ArenaConditionVariableType TEAMS

Amount of Arena.getEnabledTeams()

MIN_PLAYERS

public static final ArenaConditionVariableType MIN_PLAYERS

Arena.getMinPlayers()

MAX_PLAYERS

public static final ArenaConditionVariableType MAX_PLAYERS

Arena.getMaxPlayers()

INGAME_PLAYERS

public static final ArenaConditionVariableType INGAME_PLAYERS

Amount of Arena.getPlayers()

REMAINING_SLOTS

public static final ArenaConditionVariableType REMAINING_SLOTS

Amount until Arena.getMaxPlayers() is reached

STATUS

public static final ArenaConditionVariableType STATUS

Legacy id of Arena.getStatus()

NAME

public static final ArenaConditionVariableType NAME

Arena.getName()

DISPLAY_NAME

public static final ArenaConditionVariableType DISPLAY_NAME

Arena.getDisplayName()

TYPE

public static final ArenaConditionVariableType TYPE

Arena.getRegenerationType()

GAME_WORLD

public static final ArenaConditionVariableType GAME_WORLD

Arena.getGameWorldName()

CLONED_ARENA_NAME

public static final ArenaConditionVariableType CLONED_ARENA_NAME

Gets the name of the arena from which it has been cloned.

Returns NOT_CLONED in case it's not a cloned arena.

SERVER_CHANNEL_NAME

public static final ArenaConditionVariableType SERVER_CHANNEL_NAME

If the arena is local: Plugin tries to fetch the BungeeCord channel name and returns that one. If none has been fetched, it returns LOCAL.
If the arena is remote: Returns the channel name of the server at which the arena is located at

SERVER_PLAYING_ARENAS_COUNT

public static final ArenaConditionVariableType SERVER_PLAYING_ARENAS_COUNT

Gets the amount of arenas on the server of the testing arena that has at least 1 player

CUSTOM_MODE

public static final ArenaConditionVariableType CUSTOM_MODE

Gets the name of the custom mode, or an empty string when none is set

PLUGIN

public static final ArenaConditionVariableType PLUGIN

Custom type

Method Details

values

public static ArenaConditionVariableType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ArenaConditionVariableType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getInstance

@Nullable
public @Nullable ArenaConditionVariable<?> getInstance()

Returns the effective instance of this type.

May also return null in case the plugin has not been initialized yet.

Returns:

The instance of this type. null in case it's PLUGIN.