Package com.pixelmonmod.pixelmon.api.battles

Enum Class BattleAIMode

java.lang.Object

java.lang.Enum<BattleAIMode>

com.pixelmonmod.pixelmon.api.battles.BattleAIMode

All Implemented Interfaces:

Serializable, Comparable<BattleAIMode>, Constable

public enum BattleAIMode
extends Enum<BattleAIMode>

Modes for AI in battle.

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
ADVANCED
AGGRESSIVE
DEFAULT
RANDOM
TACTICAL

Method Summary

Modifier and Type	Method	Description
BattleAIBase	createAI(BattleParticipant participant)	Creates a new AI corresponding to the mode.
static BattleAIMode	getFromIndex(int index)	Gets an AI mode from its enum index.
String	getLocalizedName()	Gets the localized name of the AI mode.
BattleAIMode	getNextMode()	Gets the next AI mode in order.
static BattleAIMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BattleAIMode[]	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

DEFAULT

public static final BattleAIMode DEFAULT

RANDOM

public static final BattleAIMode RANDOM

AGGRESSIVE

public static final BattleAIMode AGGRESSIVE

TACTICAL

public static final BattleAIMode TACTICAL

ADVANCED

public static final BattleAIMode ADVANCED

Method Details

values

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

getFromIndex

public static BattleAIMode getFromIndex(int index)

Gets an AI mode from its enum index.

Parameters:

index - The index of the AI mode to get.

Returns:

The AI mode with the specified index, or random mode if the index is out of bounds.

getNextMode

public BattleAIMode getNextMode()

Gets the next AI mode in order.

Returns:

The next AI mode in order.

createAI

public BattleAIBase createAI(BattleParticipant participant)

Creates a new AI corresponding to the mode.

Parameters:

participant - The participant to initialize an AI for.

Returns:

A new AI corresponding to the mode.

getLocalizedName

public String getLocalizedName()

Gets the localized name of the AI mode.

Returns:

The localized name of the AI mode.