Package com.fs.starfarer.api.campaign

Enum Class CampaignEventListener.FleetDespawnReason

java.lang.Object

java.lang.Enum<CampaignEventListener.FleetDespawnReason>

com.fs.starfarer.api.campaign.CampaignEventListener.FleetDespawnReason

All Implemented Interfaces:

Serializable, Comparable<CampaignEventListener.FleetDespawnReason>, Constable

Enclosing interface:

CampaignEventListener

public static enum CampaignEventListener.FleetDespawnReason
extends Enum<CampaignEventListener.FleetDespawnReason>

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
DESTROYED_BY_BATTLE	param is a BattleAPI, with a snapshot taken before the battle.
NO_MEMBERS
NO_REASON_PROVIDED
OTHER
PLAYER_FAR_AWAY
REACHED_DESTINATION	param is a SectorEntityToken

Method Summary

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

REACHED_DESTINATION

public static final CampaignEventListener.FleetDespawnReason REACHED_DESTINATION

param is a SectorEntityToken

DESTROYED_BY_BATTLE

public static final CampaignEventListener.FleetDespawnReason DESTROYED_BY_BATTLE

param is a BattleAPI, with a snapshot taken before the battle.

NO_MEMBERS

public static final CampaignEventListener.FleetDespawnReason NO_MEMBERS

OTHER

public static final CampaignEventListener.FleetDespawnReason OTHER

NO_REASON_PROVIDED

public static final CampaignEventListener.FleetDespawnReason NO_REASON_PROVIDED

PLAYER_FAR_AWAY

public static final CampaignEventListener.FleetDespawnReason PLAYER_FAR_AWAY

Method Details

values

public static CampaignEventListener.FleetDespawnReason[] 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 CampaignEventListener.FleetDespawnReason 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