Package dev.koifysh.archipelago

Enum Class ClientStatus

java.lang.Object

java.lang.Enum<ClientStatus>

dev.koifysh.archipelago.ClientStatus

All Implemented Interfaces:

Serializable, Comparable<ClientStatus>, Constable

public enum ClientStatus
extends Enum<ClientStatus>

A Status to send to the server.
CLIENT_UNKNOWN - default, no status.
CLIENT_READY - Ready to start.
CLIENT_PLAYING - Player has started playing.
CLIENT_GOAL - Player has finished their game. This will trigger an auto-release depending on server settings.

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
CLIENT_GOAL
CLIENT_PLAYING
CLIENT_READY
CLIENT_UNKNOWN

Method Summary

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

CLIENT_UNKNOWN

@SerializedName("0")
public static final ClientStatus CLIENT_UNKNOWN

CLIENT_READY

@SerializedName("10")
public static final ClientStatus CLIENT_READY

CLIENT_PLAYING

@SerializedName("20")
public static final ClientStatus CLIENT_PLAYING

CLIENT_GOAL

@SerializedName("30")
public static final ClientStatus CLIENT_GOAL

Method Details

values

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

getValue

public int getValue()