com.fs.starfarer.api.campaign

Class BaseCampaignPlugin

java.lang.Object

com.fs.starfarer.api.campaign.BaseCampaignPlugin

All Implemented Interfaces:

CampaignPlugin

Direct Known Subclasses:

CoreCampaignPluginImpl

public class BaseCampaignPlugin
extends java.lang.Object
implements CampaignPlugin

Extend this class instead of implementing CampaignPlugin for convenience if you do not intend to implement all the methods. This will also help avoid your mod breaking when new methods are added to CampaignPlugin, since default implemenations will be added here and your implementation will inherit them.

Nested Class Summary

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

CampaignPlugin.PickPriority

Constructor Summary

Constructors

Constructor and Description
BaseCampaignPlugin()

Method Summary

Modifier and Type	Method and Description
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<AssignmentModulePlugin>	pickAssignmentAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai) See ModularFleetAIAPI documentation for details.
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<NavigationModulePlugin>	pickNavigationAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai) See ModularFleetAIAPI documentation for details.
PluginPick<ReputationActionResponsePlugin>	pickReputationActionResponsePlugin(java.lang.Object action, PersonAPI person)
PluginPick<ReputationActionResponsePlugin>	pickReputationActionResponsePlugin(java.lang.Object action, java.lang.String factionId)
PluginPick<InteractionDialogPlugin>	pickRespawnPlugin()
PluginPick<StrategicModulePlugin>	pickStrategicAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai) See ModularFleetAIAPI documentation for details.
PluginPick<FleetStubConverterPlugin>	pickStubConverter(CampaignFleetAPI fleet)
PluginPick<FleetStubConverterPlugin>	pickStubConverter(FleetStubAPI stub)
PluginPick<TacticalModulePlugin>	pickTacticalAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai) See ModularFleetAIAPI documentation for details.
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 java.lang.Object

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

Constructor Detail

BaseCampaignPlugin

public BaseCampaignPlugin()

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

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

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

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

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

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

Returns:

pickReputationActionResponsePlugin

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

Specified by:

pickReputationActionResponsePlugin in interface CampaignPlugin

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

updateFactionFacts

public void updateFactionFacts(FactionAPI faction,
                               MemoryAPI memory)

Specified by:

updateFactionFacts in interface CampaignPlugin

updateGlobalFacts

public void updateGlobalFacts(MemoryAPI memory)

Specified by:

updateGlobalFacts in interface CampaignPlugin

updatePersonFacts

public void updatePersonFacts(PersonAPI person,
                              MemoryAPI memory)

Specified by:

updatePersonFacts in interface CampaignPlugin

updatePlayerFacts

public void updatePlayerFacts(MemoryAPI memory)

Specified by:

updatePlayerFacts in interface CampaignPlugin

updateMarketFacts

public void updateMarketFacts(MarketAPI market,
                              MemoryAPI memory)

Specified by:

updateMarketFacts in interface CampaignPlugin

pickReputationActionResponsePlugin

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

Specified by:

pickReputationActionResponsePlugin in interface CampaignPlugin

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

Returns:

pickAssignmentAIModule

public PluginPick<AssignmentModulePlugin> pickAssignmentAIModule(CampaignFleetAPI fleet,
                                                                 ModularFleetAIAPI ai)

Description copied from interface: CampaignPlugin

See ModularFleetAIAPI documentation for details.

Specified by:

pickAssignmentAIModule in interface CampaignPlugin

Returns:

pickNavigationAIModule

public PluginPick<NavigationModulePlugin> pickNavigationAIModule(CampaignFleetAPI fleet,
                                                                 ModularFleetAIAPI ai)

Description copied from interface: CampaignPlugin

See ModularFleetAIAPI documentation for details.

Specified by:

pickNavigationAIModule in interface CampaignPlugin

Returns:

pickStrategicAIModule

public PluginPick<StrategicModulePlugin> pickStrategicAIModule(CampaignFleetAPI fleet,
                                                               ModularFleetAIAPI ai)

Description copied from interface: CampaignPlugin

See ModularFleetAIAPI documentation for details.

Specified by:

pickStrategicAIModule in interface CampaignPlugin

Returns:

pickTacticalAIModule

public PluginPick<TacticalModulePlugin> pickTacticalAIModule(CampaignFleetAPI fleet,
                                                             ModularFleetAIAPI ai)

Description copied from interface: CampaignPlugin

See ModularFleetAIAPI documentation for details.

Specified by:

pickTacticalAIModule in interface CampaignPlugin

Returns:

pickStubConverter

public PluginPick<FleetStubConverterPlugin> pickStubConverter(FleetStubAPI stub)

Specified by:

pickStubConverter in interface CampaignPlugin

pickStubConverter

public PluginPick<FleetStubConverterPlugin> pickStubConverter(CampaignFleetAPI fleet)

Specified by:

pickStubConverter in interface CampaignPlugin

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

Returns:

pickRespawnPlugin

public PluginPick<InteractionDialogPlugin> pickRespawnPlugin()

Specified by:

pickRespawnPlugin in interface CampaignPlugin

pickImmigrationPlugin

public PluginPick<ImmigrationPlugin> pickImmigrationPlugin(MarketAPI market)

Specified by:

pickImmigrationPlugin in interface CampaignPlugin

pickAICoreAdminPlugin

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

Specified by:

pickAICoreAdminPlugin in interface CampaignPlugin

pickFleetInflater

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

Specified by:

pickFleetInflater in interface CampaignPlugin

Parameters:

fleet -

params -

pickAICoreOfficerPlugin

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

Specified by:

pickAICoreOfficerPlugin in interface CampaignPlugin