Package dev.itsharshxd.zentrix.api.scenario.vote

Enum Class ScenarioVoteResult

java.lang.Object

java.lang.Enum<ScenarioVoteResult>

dev.itsharshxd.zentrix.api.scenario.vote.ScenarioVoteResult

All Implemented Interfaces:

Serializable, Comparable<ScenarioVoteResult>, Constable

public enum ScenarioVoteResult
extends Enum<ScenarioVoteResult>

The outcome of asking Zentrix to cast, change or clear a vote.

Since:

1.6.0

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
ACCEPTED	The vote was recorded.
ALREADY_VOTED	The player already voted for this scenario and changes are disabled.
CANCELLED	An addon cancelled the vote through the vote event.
LIMIT_REACHED	The player used up their vote limit.
NOT_ELIGIBLE	The scenario is not in this match's eligible pool.
NOT_IN_GAME	The player is not in this match.
NOT_RUNNING	Voting is not open for this match.
WITHDRAWN	The vote was taken back.

Method Summary

Modifier and Type	Method	Description
boolean	isSuccess()	Whether the vote actually changed anything.
@NotNull String	key()
static ScenarioVoteResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScenarioVoteResult[]	values()	Returns an array containing the constants of this enum class, 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

ACCEPTED

public static final ScenarioVoteResult ACCEPTED

The vote was recorded.

WITHDRAWN

public static final ScenarioVoteResult WITHDRAWN

The vote was taken back.

ALREADY_VOTED

public static final ScenarioVoteResult ALREADY_VOTED

The player already voted for this scenario and changes are disabled.

LIMIT_REACHED

public static final ScenarioVoteResult LIMIT_REACHED

The player used up their vote limit.

NOT_RUNNING

public static final ScenarioVoteResult NOT_RUNNING

Voting is not open for this match.

NOT_ELIGIBLE

public static final ScenarioVoteResult NOT_ELIGIBLE

The scenario is not in this match's eligible pool.

NOT_IN_GAME

public static final ScenarioVoteResult NOT_IN_GAME

The player is not in this match.

CANCELLED

public static final ScenarioVoteResult CANCELLED

An addon cancelled the vote through the vote event.

Method Details

values

public static ScenarioVoteResult[] values()

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

Returns:

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

valueOf

public static ScenarioVoteResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isSuccess

public boolean isSuccess()

Whether the vote actually changed anything.

key

@NotNull
public @NotNull String key()