public interface CampaignPlugin
Modifier and Type | Interface and Description |
---|---|
static class |
CampaignPlugin.PickPriority |
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) |
java.lang.String getId()
boolean isTransient()
PluginPick<InteractionDialogPlugin> pickInteractionDialogPlugin(SectorEntityToken interactionTarget)
interactionTarget
- PluginPick<InteractionDialogPlugin> pickInteractionDialogPlugin(java.lang.Object param, SectorEntityToken interactionTarget)
interactionTarget
- PluginPick<BattleCreationPlugin> pickBattleCreationPlugin(SectorEntityToken opponent)
opponent
- PluginPick<BattleAutoresolverPlugin> pickBattleAutoresolverPlugin(BattleAPI battle)
one
- two
- PluginPick<ReputationActionResponsePlugin> pickReputationActionResponsePlugin(java.lang.Object action, java.lang.String factionId)
PluginPick<ReputationActionResponsePlugin> pickReputationActionResponsePlugin(java.lang.Object action, PersonAPI person)
void updateEntityFacts(SectorEntityToken entity, MemoryAPI memory)
memory
- void updateFactionFacts(FactionAPI faction, MemoryAPI memory)
void updateGlobalFacts(MemoryAPI memory)
void updatePlayerFacts(MemoryAPI memory)
PluginPick<AssignmentModulePlugin> pickAssignmentAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai)
fleet
- ai
- PluginPick<StrategicModulePlugin> pickStrategicAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai)
fleet
- ai
- PluginPick<TacticalModulePlugin> pickTacticalAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai)
fleet
- ai
- PluginPick<NavigationModulePlugin> pickNavigationAIModule(CampaignFleetAPI fleet, ModularFleetAIAPI ai)
fleet
- ai
- PluginPick<AbilityAIPlugin> pickAbilityAI(AbilityPlugin ability, ModularFleetAIAPI ai)
ability
- PluginPick<FleetStubConverterPlugin> pickStubConverter(FleetStubAPI stub)
PluginPick<FleetStubConverterPlugin> pickStubConverter(CampaignFleetAPI fleet)
PluginPick<AutofitPlugin> pickAutofitPlugin(FleetMemberAPI member)
member
- PluginPick<InteractionDialogPlugin> pickRespawnPlugin()
PluginPick<ImmigrationPlugin> pickImmigrationPlugin(MarketAPI market)
PluginPick<AICoreAdminPlugin> pickAICoreAdminPlugin(java.lang.String commodityId)
PluginPick<AICoreOfficerPlugin> pickAICoreOfficerPlugin(java.lang.String commodityId)
PluginPick<FleetInflater> pickFleetInflater(CampaignFleetAPI fleet, java.lang.Object params)
Copyright © 2013 Fractal Softworks, LLC. All Rights Reserved.