com.fs.starfarer.api.impl.campaign

Class CoreCampaignPluginImpl

java.lang.Object

com.fs.starfarer.api.campaign.BaseCampaignPlugin

com.fs.starfarer.api.impl.campaign.CoreCampaignPluginImpl

All Implemented Interfaces:

CampaignPlugin

public class CoreCampaignPluginImpl
extends BaseCampaignPlugin

Nested Class Summary

Nested classes/interfaces inherited from interface com.fs.starfarer.api.campaign.CampaignPlugin

CampaignPlugin.PickPriority

Constructor Summary

Constructors

Constructor and Description
CoreCampaignPluginImpl()

Method Summary

Modifier and Type	Method and Description
static float	computeSmugglingSuspicionLevel(MarketAPI market)
java.lang.String	getId() Used for unregistering plugins, should be unique.
boolean	isTransient() If the plugin is transient, its data won't be included in save games and it needs to be re-added to the game every time (in ModPlugin.onGameLoad()).
PluginPick<AbilityAIPlugin>	pickAbilityAI(AbilityPlugin ability, ModularFleetAIAPI ai) AI for campaign abilities - transponder, go dark, emergency burn, etc.
PluginPick<AICoreAdminPlugin>	pickAICoreAdminPlugin(java.lang.String commodityId)
PluginPick<AICoreOfficerPlugin>	pickAICoreOfficerPlugin(java.lang.String commodityId)
PluginPick<AutofitPlugin>	pickAutofitPlugin(FleetMemberAPI member) member will be null when picking plugin to assign idle officers from fleet screen.
PluginPick<BattleAutoresolverPlugin>	pickBattleAutoresolverPlugin(BattleAPI battle) Returns a plugin used to quickly resolve a battle outcome.
PluginPick<BattleCreationPlugin>	pickBattleCreationPlugin(SectorEntityToken opponent) Returns a plugin that is used to generate the battlefield.
PluginPick<FleetInflater>	pickFleetInflater(CampaignFleetAPI fleet, java.lang.Object params)
PluginPick<ImmigrationPlugin>	pickImmigrationPlugin(MarketAPI market)
PluginPick<InteractionDialogPlugin>	pickInteractionDialogPlugin(java.lang.Object param, SectorEntityToken interactionTarget) Used for: - interaction dialogs created by clicking on a comm message action icon Return null if this CampaignPlugin implementation doesn't provide a dialog for the above use case(s).
PluginPick<InteractionDialogPlugin>	pickInteractionDialogPlugin(SectorEntityToken interactionTarget) Returns the dialog plugin to be used to drive the interaction dialog for the particular entity.
PluginPick<ReputationActionResponsePlugin>	pickReputationActionResponsePlugin(java.lang.Object action, PersonAPI person)
PluginPick<ReputationActionResponsePlugin>	pickReputationActionResponsePlugin(java.lang.Object action, java.lang.String factionId)
PluginPick<InteractionDialogPlugin>	pickRespawnPlugin()
PluginPick<FleetStubConverterPlugin>	pickStubConverter(CampaignFleetAPI fleet)
PluginPick<FleetStubConverterPlugin>	pickStubConverter(FleetStubAPI stub)
void	updateEntityFacts(SectorEntityToken entity, MemoryAPI memory) Update the "this is known by the entity about the world" facts.
void	updateFactionFacts(FactionAPI faction, MemoryAPI memory)
void	updateGlobalFacts(MemoryAPI memory)
void	updateMarketFacts(MarketAPI market, MemoryAPI memory)
void	updatePersonFacts(PersonAPI person, MemoryAPI memory)
void	updatePlayerFacts(MemoryAPI memory)

Methods inherited from class com.fs.starfarer.api.campaign.BaseCampaignPlugin

pickAssignmentAIModule, pickNavigationAIModule, pickStrategicAIModule, pickTacticalAIModule

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CoreCampaignPluginImpl

public CoreCampaignPluginImpl()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: CampaignPlugin

Used for unregistering plugins, should be unique. Can be null, but shouldn't. If not null, the game will ensure that only one copy of the plugin can be registered - new registrations will override prior ones.

Specified by:

getId in interface CampaignPlugin

Overrides:

getId in class BaseCampaignPlugin

Returns:

isTransient

public boolean isTransient()

Description copied from interface: CampaignPlugin

If the plugin is transient, its data won't be included in save games and it needs to be re-added to the game every time (in ModPlugin.onGameLoad()). If a plugin is not transient, its data is saved and it can be added in ModPlugin.onNewGame(). Plugins should be transient unless they need to save data, to improve the ability to add/remove mods from an existing game.

Specified by:

isTransient in interface CampaignPlugin

Overrides:

isTransient in class BaseCampaignPlugin

Returns:

pickInteractionDialogPlugin

public PluginPick<InteractionDialogPlugin> pickInteractionDialogPlugin(SectorEntityToken interactionTarget)

Description copied from interface: CampaignPlugin

Returns the dialog plugin to be used to drive the interaction dialog for the particular entity. Return null if this CampaignPlugin implementation doesn't provide one.

Specified by:

pickInteractionDialogPlugin in interface CampaignPlugin

Overrides:

pickInteractionDialogPlugin in class BaseCampaignPlugin

Returns:

pickInteractionDialogPlugin

public PluginPick<InteractionDialogPlugin> pickInteractionDialogPlugin(java.lang.Object param,
                                                                       SectorEntityToken interactionTarget)

Description copied from interface: CampaignPlugin

Used for: - interaction dialogs created by clicking on a comm message action icon Return null if this CampaignPlugin implementation doesn't provide a dialog for the above use case(s).

Specified by:

pickInteractionDialogPlugin in interface CampaignPlugin

Overrides:

pickInteractionDialogPlugin in class BaseCampaignPlugin

Returns:

pickAbilityAI

public PluginPick<AbilityAIPlugin> pickAbilityAI(AbilityPlugin ability,
                                                 ModularFleetAIAPI ai)

Description copied from interface: CampaignPlugin

AI for campaign abilities - transponder, go dark, emergency burn, etc.

Specified by:

pickAbilityAI in interface CampaignPlugin

Overrides:

pickAbilityAI in class BaseCampaignPlugin

Returns:

pickBattleCreationPlugin

public PluginPick<BattleCreationPlugin> pickBattleCreationPlugin(SectorEntityToken opponent)

Description copied from interface: CampaignPlugin

Returns a plugin that is used to generate the battlefield. Mods could use this to create a custom battlefield for a special opponent, for example, without having to override the core BattleCreationPlugin implementation. Return null if this CampaignPlugin implementation doesn't provide one.

Specified by:

pickBattleCreationPlugin in interface CampaignPlugin

Overrides:

pickBattleCreationPlugin in class BaseCampaignPlugin

Returns:

pickBattleAutoresolverPlugin

public PluginPick<BattleAutoresolverPlugin> pickBattleAutoresolverPlugin(BattleAPI battle)

Description copied from interface: CampaignPlugin

Returns a plugin used to quickly resolve a battle outcome. Return null if this CampaignPlugin implementation doesn't provide one.

Specified by:

pickBattleAutoresolverPlugin in interface CampaignPlugin

Overrides:

pickBattleAutoresolverPlugin in class BaseCampaignPlugin

Returns:

pickReputationActionResponsePlugin

public PluginPick<ReputationActionResponsePlugin> pickReputationActionResponsePlugin(java.lang.Object action,
                                                                                     java.lang.String factionId)

Specified by:

pickReputationActionResponsePlugin in interface CampaignPlugin

Overrides:

pickReputationActionResponsePlugin in class BaseCampaignPlugin

pickReputationActionResponsePlugin

public PluginPick<ReputationActionResponsePlugin> pickReputationActionResponsePlugin(java.lang.Object action,
                                                                                     PersonAPI person)

Specified by:

pickReputationActionResponsePlugin in interface CampaignPlugin

Overrides:

pickReputationActionResponsePlugin in class BaseCampaignPlugin

updateEntityFacts

public void updateEntityFacts(SectorEntityToken entity,
                              MemoryAPI memory)

Description copied from interface: CampaignPlugin

Update the "this is known by the entity about the world" facts. Any variables set here should have an expiration time of 0, since this method will be called every time the getMemory() method is called. Having facts not expire would clutter up the memory. Mod-added facts should have their variable names use a mod-specific prefix to avoid conflicts.

Specified by:

updateEntityFacts in interface CampaignPlugin

Overrides:

updateEntityFacts in class BaseCampaignPlugin

updateMarketFacts

public void updateMarketFacts(MarketAPI market,
                              MemoryAPI memory)

Specified by:

updateMarketFacts in interface CampaignPlugin

Overrides:

updateMarketFacts in class BaseCampaignPlugin

computeSmugglingSuspicionLevel

public static final float computeSmugglingSuspicionLevel(MarketAPI market)

updatePersonFacts

public void updatePersonFacts(PersonAPI person,
                              MemoryAPI memory)

Specified by:

updatePersonFacts in interface CampaignPlugin

Overrides:

updatePersonFacts in class BaseCampaignPlugin

updateFactionFacts

public void updateFactionFacts(FactionAPI faction,
                               MemoryAPI memory)

Specified by:

updateFactionFacts in interface CampaignPlugin

Overrides:

updateFactionFacts in class BaseCampaignPlugin

updateGlobalFacts

public void updateGlobalFacts(MemoryAPI memory)

Specified by:

updateGlobalFacts in interface CampaignPlugin

Overrides:

updateGlobalFacts in class BaseCampaignPlugin

updatePlayerFacts

public void updatePlayerFacts(MemoryAPI memory)

Specified by:

updatePlayerFacts in interface CampaignPlugin

Overrides:

updatePlayerFacts in class BaseCampaignPlugin

pickStubConverter

public PluginPick<FleetStubConverterPlugin> pickStubConverter(CampaignFleetAPI fleet)

Specified by:

pickStubConverter in interface CampaignPlugin

Overrides:

pickStubConverter in class BaseCampaignPlugin

pickStubConverter

public PluginPick<FleetStubConverterPlugin> pickStubConverter(FleetStubAPI stub)

Specified by:

pickStubConverter in interface CampaignPlugin

Overrides:

pickStubConverter in class BaseCampaignPlugin

pickAutofitPlugin

public PluginPick<AutofitPlugin> pickAutofitPlugin(FleetMemberAPI member)

Description copied from interface: CampaignPlugin

member will be null when picking plugin to assign idle officers from fleet screen. Only used for autofit in the refit screen. For NPC fleets, see: DefaultFleetInflater.

Specified by:

pickAutofitPlugin in interface CampaignPlugin

Overrides:

pickAutofitPlugin in class BaseCampaignPlugin

Returns:

pickRespawnPlugin

public PluginPick<InteractionDialogPlugin> pickRespawnPlugin()

Specified by:

pickRespawnPlugin in interface CampaignPlugin

Overrides:

pickRespawnPlugin in class BaseCampaignPlugin

pickImmigrationPlugin

public PluginPick<ImmigrationPlugin> pickImmigrationPlugin(MarketAPI market)

Specified by:

pickImmigrationPlugin in interface CampaignPlugin

Overrides:

pickImmigrationPlugin in class BaseCampaignPlugin

pickAICoreAdminPlugin

public PluginPick<AICoreAdminPlugin> pickAICoreAdminPlugin(java.lang.String commodityId)

Specified by:

pickAICoreAdminPlugin in interface CampaignPlugin

Overrides:

pickAICoreAdminPlugin in class BaseCampaignPlugin

pickAICoreOfficerPlugin

public PluginPick<AICoreOfficerPlugin> pickAICoreOfficerPlugin(java.lang.String commodityId)

Specified by:

pickAICoreOfficerPlugin in interface CampaignPlugin

Overrides:

pickAICoreOfficerPlugin in class BaseCampaignPlugin

pickFleetInflater

public PluginPick<FleetInflater> pickFleetInflater(CampaignFleetAPI fleet,
                                                   java.lang.Object params)

Specified by:

pickFleetInflater in interface CampaignPlugin

Overrides:

pickFleetInflater in class BaseCampaignPlugin