com.fs.starfarer.api.campaign

Enum FleetEncounterContextPlugin.EngagementOutcome

java.lang.Object

java.lang.Enum<FleetEncounterContextPlugin.EngagementOutcome>

com.fs.starfarer.api.campaign.FleetEncounterContextPlugin.EngagementOutcome

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FleetEncounterContextPlugin.EngagementOutcome>

Enclosing interface:

FleetEncounterContextPlugin

public static enum FleetEncounterContextPlugin.EngagementOutcome
extends java.lang.Enum<FleetEncounterContextPlugin.EngagementOutcome>

This, and any FleetEncounterContext code that uses this, is only used for battles involving the player, and not AI vs AI autoresloved ones.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BATTLE_ENEMY_WIN
BATTLE_ENEMY_WIN_TOTAL
BATTLE_PLAYER_OUT_FIRST_LOSS
BATTLE_PLAYER_OUT_FIRST_WIN
BATTLE_PLAYER_WIN
BATTLE_PLAYER_WIN_TOTAL
ESCAPE_ENEMY_LOSS_TOTAL
ESCAPE_ENEMY_SUCCESS
ESCAPE_ENEMY_WIN
ESCAPE_ENEMY_WIN_TOTAL
ESCAPE_PLAYER_LOSS_TOTAL
ESCAPE_PLAYER_OUT_FIRST_LOSS
ESCAPE_PLAYER_OUT_FIRST_WIN
ESCAPE_PLAYER_SUCCESS
ESCAPE_PLAYER_WIN
ESCAPE_PLAYER_WIN_TOTAL
MUTUAL_DESTRUCTION
PURSUIT_PLAYER_OUT_FIRST_LOSS
PURSUIT_PLAYER_OUT_FIRST_WIN

Method Summary

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

MUTUAL_DESTRUCTION

public static final FleetEncounterContextPlugin.EngagementOutcome MUTUAL_DESTRUCTION

BATTLE_PLAYER_WIN

public static final FleetEncounterContextPlugin.EngagementOutcome BATTLE_PLAYER_WIN

BATTLE_PLAYER_WIN_TOTAL

public static final FleetEncounterContextPlugin.EngagementOutcome BATTLE_PLAYER_WIN_TOTAL

BATTLE_ENEMY_WIN

public static final FleetEncounterContextPlugin.EngagementOutcome BATTLE_ENEMY_WIN

BATTLE_ENEMY_WIN_TOTAL

public static final FleetEncounterContextPlugin.EngagementOutcome BATTLE_ENEMY_WIN_TOTAL

ESCAPE_PLAYER_LOSS_TOTAL

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_PLAYER_LOSS_TOTAL

ESCAPE_PLAYER_SUCCESS

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_PLAYER_SUCCESS

ESCAPE_PLAYER_WIN

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_PLAYER_WIN

ESCAPE_PLAYER_WIN_TOTAL

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_PLAYER_WIN_TOTAL

ESCAPE_ENEMY_LOSS_TOTAL

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_ENEMY_LOSS_TOTAL

ESCAPE_ENEMY_SUCCESS

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_ENEMY_SUCCESS

ESCAPE_ENEMY_WIN

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_ENEMY_WIN

ESCAPE_ENEMY_WIN_TOTAL

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_ENEMY_WIN_TOTAL

BATTLE_PLAYER_OUT_FIRST_WIN

public static final FleetEncounterContextPlugin.EngagementOutcome BATTLE_PLAYER_OUT_FIRST_WIN

BATTLE_PLAYER_OUT_FIRST_LOSS

public static final FleetEncounterContextPlugin.EngagementOutcome BATTLE_PLAYER_OUT_FIRST_LOSS

ESCAPE_PLAYER_OUT_FIRST_WIN

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_PLAYER_OUT_FIRST_WIN

ESCAPE_PLAYER_OUT_FIRST_LOSS

public static final FleetEncounterContextPlugin.EngagementOutcome ESCAPE_PLAYER_OUT_FIRST_LOSS

PURSUIT_PLAYER_OUT_FIRST_WIN

public static final FleetEncounterContextPlugin.EngagementOutcome PURSUIT_PLAYER_OUT_FIRST_WIN

PURSUIT_PLAYER_OUT_FIRST_LOSS

public static final FleetEncounterContextPlugin.EngagementOutcome PURSUIT_PLAYER_OUT_FIRST_LOSS

Method Detail

values

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

Returns:

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

valueOf

public static FleetEncounterContextPlugin.EngagementOutcome 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