com.fs.starfarer.api.campaign

Enum BattleAPI.BattleSide

java.lang.Object

java.lang.Enum<BattleAPI.BattleSide>

com.fs.starfarer.api.campaign.BattleAPI.BattleSide

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BattleAPI.BattleSide>

Enclosing interface:

BattleAPI

public static enum BattleAPI.BattleSide
extends java.lang.Enum<BattleAPI.BattleSide>

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_JOIN
ONE
TWO

Method Summary

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

ONE

public static final BattleAPI.BattleSide ONE

TWO

public static final BattleAPI.BattleSide TWO

NO_JOIN

public static final BattleAPI.BattleSide NO_JOIN

Method Detail

values

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

Returns:

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

valueOf

public static BattleAPI.BattleSide 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