com.fs.starfarer.api.mission
Enum FleetSide

java.lang.Object
  extended by java.lang.Enum<FleetSide>
      extended by com.fs.starfarer.api.mission.FleetSide
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FleetSide>

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

Defines a side in a mission.

Author:
Alex Mosolov Copyright 2012 Fractal Softworks, LLC

Enum Constant Summary
ENEMY
           
PLAYER
           
 
Method Summary
static FleetSide valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FleetSide[] 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

PLAYER

public static final FleetSide PLAYER

ENEMY

public static final FleetSide ENEMY
Method Detail

values

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

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

valueOf

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


Copyright © 2013 Fractal Softworks, LLC. All Rights Reserved.