com.pixelmonmod.pixelmon.api.battles

Enum BattleType

java.lang.Object

java.lang.Enum<BattleType>

com.pixelmonmod.pixelmon.api.battles.BattleType

All Implemented Interfaces:

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

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

Different battle formats.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOUBLE
HORDE
RAID
ROTATION
SINGLE
TRIPLE

Method Summary

Modifier and Type	Method and Description
boolean	areSlotsLocked()
static BattleType	getFromOrdinal(int ordinal) Gets a battle type from its enum ordinal.
java.lang.String	getLocalizedName() Gets the localized name of the battle type.
int	getNumPokemon()
BattleType	next() Gets the battle type directly after the current one.
static BattleType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BattleType[]	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

SINGLE

public static final BattleType SINGLE

DOUBLE

public static final BattleType DOUBLE

TRIPLE

public static final BattleType TRIPLE

ROTATION

public static final BattleType ROTATION

RAID

public static final BattleType RAID

HORDE

public static final BattleType HORDE

Method Detail

values

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

Returns:

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

valueOf

public static BattleType 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

getNumPokemon

public int getNumPokemon()

areSlotsLocked

public boolean areSlotsLocked()

next

public BattleType next()

Gets the battle type directly after the current one.

Returns:

The battle type directly after the current one.

getLocalizedName

public java.lang.String getLocalizedName()

Gets the localized name of the battle type.

Returns:

The localized name of the battle type.

getFromOrdinal

public static BattleType getFromOrdinal(int ordinal)

Gets a battle type from its enum ordinal.

Parameters:

ordinal - The ordinal of the response enum.

Returns:

The battle type corresponding with the specified ordinal, or Single if the ordinal is out of bounds.