com.comphenix.protocol.injector

Enum GamePhase

java.lang.Object

java.lang.Enum<GamePhase>

com.comphenix.protocol.injector.GamePhase

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GamePhase>

public enum GamePhase
extends java.lang.Enum<GamePhase>

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

Author:

Kristian

Enum Constant Summary

Enum Constants

Enum Constant and 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

Methods

Modifier and Type	Method and 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(java.lang.String name) Returns the enum constant of this type with the specified name.
static GamePhase[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static GamePhase[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GamePhase c : GamePhase.values())
    System.out.println(c);

Returns:

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

valueOf

public static GamePhase valueOf(java.lang.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:

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

java.lang.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.