CampaignPlugin.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import com.fs.starfarer.api.PluginPick;
import com.fs.starfarer.api.campaign.ai.AbilityAIPlugin;
import com.fs.starfarer.api.campaign.ai.AssignmentModulePlugin;
import com.fs.starfarer.api.campaign.ai.ModularFleetAIAPI;
import com.fs.starfarer.api.campaign.ai.NavigationModulePlugin;
import com.fs.starfarer.api.campaign.ai.StrategicModulePlugin;
import com.fs.starfarer.api.campaign.ai.TacticalModulePlugin;
import com.fs.starfarer.api.campaign.econ.ImmigrationPlugin;
import com.fs.starfarer.api.campaign.econ.MarketAPI;
import com.fs.starfarer.api.campaign.rules.MemoryAPI;
import com.fs.starfarer.api.characters.AbilityPlugin;
import com.fs.starfarer.api.characters.PersonAPI;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import com.fs.starfarer.api.plugins.AutofitPlugin;
 
 
public interface CampaignPlugin {
 
    public static enum PickPriority {
        CORE_GENERAL,
        
        MOD_GENERAL,
        
        CORE_SET,
        
        MOD_SET,
        
        CORE_SPECIFIC,
        
        MOD_SPECIFIC,
        
        HIGHEST,
        
    }
    
    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);
 
}