Module be.yildizgames.feature.player.shared

Package be.yildizgames.engine.feature.player

Enum PlayerManager.PlayerRelation

java.lang.Object

java.lang.Enum<PlayerManager.PlayerRelation>

be.yildizgames.engine.feature.player.PlayerManager.PlayerRelation

All Implemented Interfaces:

Serializable, Comparable<PlayerManager.PlayerRelation>

Enclosing class:

PlayerManager

public static enum PlayerManager.PlayerRelation
extends Enum<PlayerManager.PlayerRelation>

Relation between 2 players.

Author:

Van den Borre Grégory

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLY	Players are allied.
ENEMY	Players are enemies.
NEUTRAL	Player are neutral.
SAME	The players are the same.

Method Summary

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

SAME

public static final PlayerManager.PlayerRelation SAME

The players are the same.

ENEMY

public static final PlayerManager.PlayerRelation ENEMY

Players are enemies.

ALLY

public static final PlayerManager.PlayerRelation ALLY

Players are allied.

NEUTRAL

public static final PlayerManager.PlayerRelation NEUTRAL

Player are neutral.

Method Detail

values

public static PlayerManager.PlayerRelation[] 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 (PlayerManager.PlayerRelation c : PlayerManager.PlayerRelation.values())
    System.out.println(c);

Returns:

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

valueOf

public static PlayerManager.PlayerRelation valueOf(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:

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

NullPointerException - if the argument is null