Package com.fs.starfarer.api.campaign

Enum Class CampaignPlugin.PickPriority

java.lang.Object

java.lang.Enum<CampaignPlugin.PickPriority>

com.fs.starfarer.api.campaign.CampaignPlugin.PickPriority

All Implemented Interfaces:

Serializable, Comparable<CampaignPlugin.PickPriority>, Constable

Enclosing interface:

CampaignPlugin

public static enum CampaignPlugin.PickPriority
extends Enum<CampaignPlugin.PickPriority>

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
CORE_GENERAL	Lowest priority.
CORE_SET	Should only be used by core code.
CORE_SPECIFIC	Should be used by core code only for specific encounters.
HIGHEST	Absolute highest priority; shouldn't be used without good reason.
MOD_GENERAL	Should be used by mods for wholesale replacement of campaign features.
MOD_SET	For a plugin that handles a set of circumstances.
MOD_SPECIFIC	Should be used by mods for specific encounters, that is, encounters that aren't handled by any of the _GENERAL and _SET priority plugins.

Method Summary

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

CORE_GENERAL

public static final CampaignPlugin.PickPriority CORE_GENERAL

Lowest priority. Should only be used by core code, a modded plugin with this priority may not end up being used anywhere, as what gets picked when multiple plugins have the same priority is undefined.

MOD_GENERAL

public static final CampaignPlugin.PickPriority MOD_GENERAL

Should be used by mods for wholesale replacement of campaign features.

CORE_SET

public static final CampaignPlugin.PickPriority CORE_SET

Should only be used by core code.

MOD_SET

public static final CampaignPlugin.PickPriority MOD_SET

For a plugin that handles a set of circumstances. For example "interaction with all jungle worlds". Overrides any _GENERAL prioritiy implementations (i.e. "interaction with all planets"). Is overriden by _SPECIFIC priority ("interaction with this particular planet").

CORE_SPECIFIC

public static final CampaignPlugin.PickPriority CORE_SPECIFIC

Should be used by core code only for specific encounters. For example, a "special" planet or fleet could have their own dialog, and the priority of this would override a mod that replaces the general interactions with all planets or fleets.

MOD_SPECIFIC

public static final CampaignPlugin.PickPriority MOD_SPECIFIC

Should be used by mods for specific encounters, that is, encounters that aren't handled by any of the _GENERAL and _SET priority plugins. For example, if a specific fleet has a special encounter dialog, it would be returned using this priority.

HIGHEST

public static final CampaignPlugin.PickPriority HIGHEST

Absolute highest priority; shouldn't be used without good reason. A mod compilation might use this to resolve conflicts introduced by mods it contains.

Method Details

values

public static CampaignPlugin.PickPriority[] 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 CampaignPlugin.PickPriority 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