Inheritance diagram for com.fs.starfarer.api.campaign.BaseCampaignPlugin:

Collaboration diagram for com.fs.starfarer.api.campaign.BaseCampaignPlugin:

Public Member Functions
String	getId ()

boolean	isTransient ()

PluginPick< BattleCreationPlugin >	pickBattleCreationPlugin (SectorEntityToken opponent)

PluginPick< InteractionDialogPlugin >	pickInteractionDialogPlugin (SectorEntityToken interactionTarget)

PluginPick< InteractionDialogPlugin >	pickInteractionDialogPlugin (Object param, SectorEntityToken interactionTarget)

PluginPick< BattleAutoresolverPlugin >	pickBattleAutoresolverPlugin (BattleAPI battle)

PluginPick< ReputationActionResponsePlugin >	pickReputationActionResponsePlugin (Object action, String factionId)

void	updateEntityFacts (SectorEntityToken entity, MemoryAPI memory)

void	updateFactionFacts (FactionAPI faction, MemoryAPI memory)

void	updateGlobalFacts (MemoryAPI memory)

void	updatePersonFacts (PersonAPI person, MemoryAPI memory)

void	updatePlayerFacts (MemoryAPI memory)

void	updateMarketFacts (MarketAPI market, MemoryAPI memory)

PluginPick< ReputationActionResponsePlugin >	pickReputationActionResponsePlugin (Object action, PersonAPI person)

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

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

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

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

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

PluginPick< FleetStubConverterPlugin >	pickStubConverter (FleetStubAPI stub)

PluginPick< FleetStubConverterPlugin >	pickStubConverter (CampaignFleetAPI fleet)

PluginPick< AutofitPlugin >	pickAutofitPlugin (FleetMemberAPI member)

PluginPick< InteractionDialogPlugin >	pickRespawnPlugin ()

PluginPick< ImmigrationPlugin >	pickImmigrationPlugin (MarketAPI market)

PluginPick< AICoreAdminPlugin >	pickAICoreAdminPlugin (String commodityId)

PluginPick< FleetInflater >	pickFleetInflater (CampaignFleetAPI fleet, Object params)

PluginPick< AICoreOfficerPlugin >	pickAICoreOfficerPlugin (String commodityId)

Detailed Description

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.

Author: Alex Mosolov

Definition at line 29 of file BaseCampaignPlugin.java.

Member Function Documentation

◆ getId()

String com.fs.starfarer.api.campaign.BaseCampaignPlugin.getId ( )

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.

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 31 of file BaseCampaignPlugin.java.

◆ isTransient()

boolean com.fs.starfarer.api.campaign.BaseCampaignPlugin.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()).

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.

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 35 of file BaseCampaignPlugin.java.

◆ pickAbilityAI()

PluginPick< AbilityAIPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickAbilityAI	(	AbilityPlugin	ability,
		ModularFleetAIAPI	ai
	)

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

Parameters

ability

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 88 of file BaseCampaignPlugin.java.

◆ pickAICoreAdminPlugin()

PluginPick< AICoreAdminPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickAICoreAdminPlugin ( String commodityId )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 132 of file BaseCampaignPlugin.java.

◆ pickAICoreOfficerPlugin()

PluginPick< AICoreOfficerPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickAICoreOfficerPlugin ( String commodityId )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 144 of file BaseCampaignPlugin.java.

◆ pickAssignmentAIModule()

PluginPick< AssignmentModulePlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickAssignmentAIModule	(	CampaignFleetAPI	fleet,
		ModularFleetAIAPI	ai
	)

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 92 of file BaseCampaignPlugin.java.

◆ pickAutofitPlugin()

PluginPick< AutofitPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickAutofitPlugin ( FleetMemberAPI member )

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.

Parameters

member

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 120 of file BaseCampaignPlugin.java.

◆ pickBattleAutoresolverPlugin()

PluginPick< BattleAutoresolverPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickBattleAutoresolverPlugin ( BattleAPI battle )

Returns a plugin used to quickly resolve a battle outcome.

Return null if this CampaignPlugin implementation doesn't provide one.

Parameters

one
two

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 51 of file BaseCampaignPlugin.java.

◆ pickBattleCreationPlugin()

PluginPick< BattleCreationPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickBattleCreationPlugin ( SectorEntityToken opponent )

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.

Parameters

opponent

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 39 of file BaseCampaignPlugin.java.

◆ pickFleetInflater()

PluginPick< FleetInflater > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickFleetInflater	(	CampaignFleetAPI	fleet,
		Object	params
	)

Parameters

fleet
params

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 140 of file BaseCampaignPlugin.java.

◆ pickImmigrationPlugin()

PluginPick< ImmigrationPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickImmigrationPlugin ( MarketAPI market )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 128 of file BaseCampaignPlugin.java.

◆ pickInteractionDialogPlugin() [1/2]

PluginPick< InteractionDialogPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickInteractionDialogPlugin	(	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).

Parameters

interactionTarget

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 47 of file BaseCampaignPlugin.java.

◆ pickInteractionDialogPlugin() [2/2]

PluginPick< InteractionDialogPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickInteractionDialogPlugin ( SectorEntityToken interactionTarget )

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.

Parameters

interactionTarget

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 43 of file BaseCampaignPlugin.java.

◆ pickNavigationAIModule()

PluginPick< NavigationModulePlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickNavigationAIModule	(	CampaignFleetAPI	fleet,
		ModularFleetAIAPI	ai
	)

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 97 of file BaseCampaignPlugin.java.

◆ pickReputationActionResponsePlugin() [1/2]

PluginPick< ReputationActionResponsePlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickReputationActionResponsePlugin	(	Object	action,
		PersonAPI	person
	)

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 84 of file BaseCampaignPlugin.java.

◆ pickReputationActionResponsePlugin() [2/2]

PluginPick< ReputationActionResponsePlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickReputationActionResponsePlugin	(	Object	action,
		String	factionId
	)

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 55 of file BaseCampaignPlugin.java.

◆ pickRespawnPlugin()

PluginPick< InteractionDialogPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickRespawnPlugin ( )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 124 of file BaseCampaignPlugin.java.

◆ pickStrategicAIModule()

PluginPick< StrategicModulePlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickStrategicAIModule	(	CampaignFleetAPI	fleet,
		ModularFleetAIAPI	ai
	)

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 102 of file BaseCampaignPlugin.java.

◆ pickStubConverter() [1/2]

PluginPick< FleetStubConverterPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickStubConverter ( CampaignFleetAPI fleet )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 116 of file BaseCampaignPlugin.java.

◆ pickStubConverter() [2/2]

PluginPick< FleetStubConverterPlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickStubConverter ( FleetStubAPI stub )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 112 of file BaseCampaignPlugin.java.

◆ pickTacticalAIModule()

PluginPick< TacticalModulePlugin > com.fs.starfarer.api.campaign.BaseCampaignPlugin.pickTacticalAIModule	(	CampaignFleetAPI	fleet,
		ModularFleetAIAPI	ai
	)

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 107 of file BaseCampaignPlugin.java.

◆ updateEntityFacts()

void com.fs.starfarer.api.campaign.BaseCampaignPlugin.updateEntityFacts	(	SectorEntityToken	entity,
		MemoryAPI	memory
	)

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.

Parameters

memory

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 60 of file BaseCampaignPlugin.java.

◆ updateFactionFacts()

void com.fs.starfarer.api.campaign.BaseCampaignPlugin.updateFactionFacts	(	FactionAPI	faction,
		MemoryAPI	memory
	)

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 64 of file BaseCampaignPlugin.java.

◆ updateGlobalFacts()

void com.fs.starfarer.api.campaign.BaseCampaignPlugin.updateGlobalFacts ( MemoryAPI memory )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 68 of file BaseCampaignPlugin.java.

◆ updateMarketFacts()

void com.fs.starfarer.api.campaign.BaseCampaignPlugin.updateMarketFacts	(	MarketAPI	market,
		MemoryAPI	memory
	)

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 80 of file BaseCampaignPlugin.java.

◆ updatePersonFacts()

void com.fs.starfarer.api.campaign.BaseCampaignPlugin.updatePersonFacts	(	PersonAPI	person,
		MemoryAPI	memory
	)

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 72 of file BaseCampaignPlugin.java.

◆ updatePlayerFacts()

void com.fs.starfarer.api.campaign.BaseCampaignPlugin.updatePlayerFacts ( MemoryAPI memory )

Implements com.fs.starfarer.api.campaign.CampaignPlugin.

Definition at line 76 of file BaseCampaignPlugin.java.

The documentation for this class was generated from the following file:

src/com/fs/starfarer/api/campaign/BaseCampaignPlugin.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getId()

◆ isTransient()

◆ pickAbilityAI()

◆ pickAICoreAdminPlugin()

◆ pickAICoreOfficerPlugin()

◆ pickAssignmentAIModule()

◆ pickAutofitPlugin()

◆ pickBattleAutoresolverPlugin()

◆ pickBattleCreationPlugin()

◆ pickFleetInflater()

◆ pickImmigrationPlugin()

◆ pickInteractionDialogPlugin() [1/2]

◆ pickInteractionDialogPlugin() [2/2]

◆ pickNavigationAIModule()

◆ pickReputationActionResponsePlugin() [1/2]

◆ pickReputationActionResponsePlugin() [2/2]

◆ pickRespawnPlugin()

◆ pickStrategicAIModule()

◆ pickStubConverter() [1/2]

◆ pickStubConverter() [2/2]

◆ pickTacticalAIModule()

◆ updateEntityFacts()

◆ updateFactionFacts()

◆ updateGlobalFacts()

◆ updateMarketFacts()

◆ updatePersonFacts()

◆ updatePlayerFacts()