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

Enum Class ScenarioVoteStatus

java.lang.Object

java.lang.Enum<ScenarioVoteStatus>

dev.itsharshxd.zentrix.api.scenario.vote.ScenarioVoteStatus

All Implemented Interfaces:

Serializable, Comparable<ScenarioVoteStatus>, Constable

public enum ScenarioVoteStatus
extends Enum<ScenarioVoteStatus>

Where a match's vote stands.

A match may only leave the waiting lobby once the vote reached RESOLVED or NOT_APPLICABLE.

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
CANCELLED	The lobby was cancelled before the vote could resolve.
NOT_APPLICABLE	This match does not vote; its scenarios come from another selection mode.
PENDING	The lobby exists but voting has not opened yet.
RESOLVED	Voting closed and the winners are locked in.
RUNNING	Voting is open and players may cast or change votes.

Method Summary

Modifier and Type	Method	Description
static ScenarioVoteStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScenarioVoteStatus[]	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

NOT_APPLICABLE

public static final ScenarioVoteStatus NOT_APPLICABLE

This match does not vote; its scenarios come from another selection mode.

PENDING

public static final ScenarioVoteStatus PENDING

The lobby exists but voting has not opened yet.

RUNNING

public static final ScenarioVoteStatus RUNNING

Voting is open and players may cast or change votes.

RESOLVED

public static final ScenarioVoteStatus RESOLVED

Voting closed and the winners are locked in. The match may start.

CANCELLED

public static final ScenarioVoteStatus CANCELLED

The lobby was cancelled before the vote could resolve.

Method Details

values

public static ScenarioVoteStatus[] 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 ScenarioVoteStatus 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