Package com.fs.starfarer.api.mission

Enum Class FleetSide

java.lang.Object

java.lang.Enum<FleetSide>

com.fs.starfarer.api.mission.FleetSide

All Implemented Interfaces:

Serializable, Comparable<FleetSide>, Constable

public enum FleetSide
extends Enum<FleetSide>

Defines a side in a mission.

Author:

Alex Mosolov Copyright 2012 Fractal Softworks, LLC

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
ENEMY
PLAYER

Method Summary

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

PLAYER

public static final FleetSide PLAYER

ENEMY

public static final FleetSide ENEMY

Method Details

values

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