com.fs.starfarer.api.impl.campaign

Enum FleetEncounterContext.BoardingOutcome

java.lang.Object

java.lang.Enum<FleetEncounterContext.BoardingOutcome>

com.fs.starfarer.api.impl.campaign.FleetEncounterContext.BoardingOutcome

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FleetEncounterContext.BoardingOutcome>

Enclosing class:

FleetEncounterContext

public static enum FleetEncounterContext.BoardingOutcome
extends java.lang.Enum<FleetEncounterContext.BoardingOutcome>

Enum Constant Summary

Enum Constants

Enum Constant and Description
SELF_DESTRUCT
SHIP_ESCAPED
SHIP_ESCAPED_CLEAN
SUCCESS
SUCCESS_TOO_DAMAGED

Method Summary

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

SUCCESS

public static final FleetEncounterContext.BoardingOutcome SUCCESS

SELF_DESTRUCT

public static final FleetEncounterContext.BoardingOutcome SELF_DESTRUCT

SUCCESS_TOO_DAMAGED

public static final FleetEncounterContext.BoardingOutcome SUCCESS_TOO_DAMAGED

SHIP_ESCAPED

public static final FleetEncounterContext.BoardingOutcome SHIP_ESCAPED

SHIP_ESCAPED_CLEAN

public static final FleetEncounterContext.BoardingOutcome SHIP_ESCAPED_CLEAN

Method Detail

values

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

Returns:

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

valueOf

public static FleetEncounterContext.BoardingOutcome 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