Package com.comphenix.protocol.injector

Enum Class GamePhase

java.lang.Object

java.lang.Enum<GamePhase>

com.comphenix.protocol.injector.GamePhase

All Implemented Interfaces:

Serializable, Comparable<GamePhase>, Constable

public enum GamePhase
extends Enum<GamePhase>

The current player phase. This is used to limit the number of different injections.

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
BOTH	Listen for every sent and received packet.
LOGIN	Only listen for packets sent or received before a player has logged in.
PLAYING	Only listen for packets sent or received after a player has logged in.

Method Summary

Modifier and Type	Method	Description
boolean	hasLogin()	Determine if the current value represents the login phase.
boolean	hasPlaying()	Determine if the current value represents the playing phase.
static GamePhase	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GamePhase[]	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

LOGIN

public static final GamePhase LOGIN

Only listen for packets sent or received before a player has logged in.

PLAYING

public static final GamePhase PLAYING

Only listen for packets sent or received after a player has logged in.

BOTH

public static final GamePhase BOTH

Listen for every sent and received packet.

Method Details

values

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

hasLogin

public boolean hasLogin()

Determine if the current value represents the login phase.

Returns:

TRUE if it does, FALSE otherwise.

hasPlaying

public boolean hasPlaying()

Determine if the current value represents the playing phase.

Returns:

TRUE if it does, FALSE otherwise.