com.fs.starfarer.api.campaign.CampaignPlugin Interface Reference

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

Classes
enum	PickPriority

Public Member Functions
String	getId ()
boolean	isTransient ()
PluginPick< InteractionDialogPlugin >	pickInteractionDialogPlugin (SectorEntityToken interactionTarget)
PluginPick< InteractionDialogPlugin >	pickInteractionDialogPlugin (Object param, SectorEntityToken interactionTarget)
PluginPick< BattleCreationPlugin >	pickBattleCreationPlugin (SectorEntityToken opponent)
PluginPick< BattleAutoresolverPlugin >	pickBattleAutoresolverPlugin (BattleAPI battle)
PluginPick< ReputationActionResponsePlugin >	pickReputationActionResponsePlugin (Object action, String factionId)
PluginPick< ReputationActionResponsePlugin >	pickReputationActionResponsePlugin (Object action, PersonAPI person)
void	updateEntityFacts (SectorEntityToken entity, MemoryAPI memory)
void	updatePersonFacts (PersonAPI person, MemoryAPI memory)
void	updateFactionFacts (FactionAPI faction, MemoryAPI memory)
void	updateGlobalFacts (MemoryAPI memory)
void	updatePlayerFacts (MemoryAPI memory)
void	updateMarketFacts (MarketAPI market, MemoryAPI memory)
PluginPick< AssignmentModulePlugin >	pickAssignmentAIModule (CampaignFleetAPI fleet, ModularFleetAIAPI ai)
PluginPick< StrategicModulePlugin >	pickStrategicAIModule (CampaignFleetAPI fleet, ModularFleetAIAPI ai)
PluginPick< TacticalModulePlugin >	pickTacticalAIModule (CampaignFleetAPI fleet, ModularFleetAIAPI ai)
PluginPick< NavigationModulePlugin >	pickNavigationAIModule (CampaignFleetAPI fleet, ModularFleetAIAPI ai)
PluginPick< AbilityAIPlugin >	pickAbilityAI (AbilityPlugin ability, 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< AICoreOfficerPlugin >	pickAICoreOfficerPlugin (String commodityId)
PluginPick< FleetInflater >	pickFleetInflater (CampaignFleetAPI fleet, Object params)

Detailed Description

Definition at line 19 of file CampaignPlugin.java.

Member Function Documentation

getId()

String com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

isTransient()

boolean com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickAbilityAI()

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

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

Parameters

ability

Returns

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickAICoreAdminPlugin()

PluginPick< AICoreAdminPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.pickAICoreAdminPlugin

(

String

commodityId

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickAICoreOfficerPlugin()

PluginPick< AICoreOfficerPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.pickAICoreOfficerPlugin

(

String

commodityId

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickAssignmentAIModule()

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

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickAutofitPlugin()

PluginPick< AutofitPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickBattleAutoresolverPlugin()

PluginPick< BattleAutoresolverPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickBattleCreationPlugin()

PluginPick< BattleCreationPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickFleetInflater()

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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickImmigrationPlugin()

PluginPick< ImmigrationPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.pickImmigrationPlugin

(

MarketAPI

market

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickInteractionDialogPlugin() [1/2]

PluginPick< InteractionDialogPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickInteractionDialogPlugin() [2/2]

PluginPick< InteractionDialogPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickNavigationAIModule()

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

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickReputationActionResponsePlugin() [1/2]

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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickReputationActionResponsePlugin() [2/2]

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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickRespawnPlugin()

PluginPick< InteractionDialogPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.pickRespawnPlugin

(

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickStrategicAIModule()

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

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickStubConverter() [1/2]

PluginPick< FleetStubConverterPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.pickStubConverter

(

CampaignFleetAPI

fleet

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickStubConverter() [2/2]

PluginPick< FleetStubConverterPlugin > com.fs.starfarer.api.campaign.CampaignPlugin.pickStubConverter

(

FleetStubAPI

stub

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

pickTacticalAIModule()

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

See ModularFleetAIAPI documentation for details.

Parameters

fleet
ai

Returns

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

updateEntityFacts()

void com.fs.starfarer.api.campaign.CampaignPlugin.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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

updateFactionFacts()

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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

updateGlobalFacts()

void com.fs.starfarer.api.campaign.CampaignPlugin.updateGlobalFacts

(

MemoryAPI

memory

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

updateMarketFacts()

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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

updatePersonFacts()

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

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

updatePlayerFacts()

void com.fs.starfarer.api.campaign.CampaignPlugin.updatePlayerFacts

(

MemoryAPI

memory

)

Implemented in com.fs.starfarer.api.campaign.BaseCampaignPlugin.

---

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

• src/com/fs/starfarer/api/campaign/CampaignPlugin.java