InteractionDialogAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.awt.Color;
import java.util.List;
 
import com.fs.starfarer.api.campaign.CampaignUIAPI.CoreUITradeMode;
import com.fs.starfarer.api.campaign.econ.Industry;
import com.fs.starfarer.api.campaign.econ.MarketAPI;
import com.fs.starfarer.api.combat.BattleCreationContext;
import com.fs.starfarer.api.fleet.FleetMemberAPI;
import com.fs.starfarer.api.impl.campaign.graid.GroundRaidObjectivePlugin;
 
 
public interface InteractionDialogAPI {
 
    void setTextWidth(float width);
    void setTextHeight(float height);
    void setXOffset(float xOffset);
    void setYOffset(float yOffset);
    void setPromptText(String promptText);
    
    void hideTextPanel();
    void showTextPanel();
    
    float getTextWidth();
    float getTextHeight();
    float getXOffset();
    float getYOffset();
    String getPromptText();
    
    void flickerStatic(float in, float out);
 
    OptionPanelAPI getOptionPanel();
    TextPanelAPI getTextPanel();
    VisualPanelAPI getVisualPanel();
    
    SectorEntityToken getInteractionTarget();
    
    InteractionDialogPlugin getPlugin();
 
 
    void setOptionOnEscape(String text, Object optionId);
 
    void startBattle(BattleCreationContext context);
    void dismiss();
    void dismissAsCancel();
    
    void showFleetMemberPickerDialog(String title, String okText, String cancelText,
                                     int rows, int cols, float iconSize, boolean canPickNotReady, boolean canPickMultiple,
                                     List<FleetMemberAPI> pool, FleetMemberPickerListener listener);
    
    void showCustomDialog(float customPanelWidth, float customPanelHeight, CustomDialogDelegate delegate);
    
    
    
//  /**
//   * Temporary hack, to be used until proper dialog mechanics are in.
//   * Doesn't belong in this interface conceptually (hence "hack").
//   * @param context
//   * @param playerFleet
//   * @param otherFleet
//   * @return
//   */
//  String getNPCText(FleetEncounterContextPlugin context, CampaignFleetAPI playerFleet, CampaignFleetAPI otherFleet);
    
    void hideVisualPanel();
    
    void showCommDirectoryDialog(CommDirectoryAPI dir);
    void setOptionOnConfirm(String text, Object optionId);
    void setOpacity(float opacity);
    void setBackgroundDimAmount(float backgroundDimAmount);
    
    void setPlugin(InteractionDialogPlugin plugin);
    void setInteractionTarget(SectorEntityToken interactionTarget);
    void showCargoPickerDialog(String title, String okText, String cancelText, 
            boolean small, float textPanelWidth, CargoAPI cargo, CargoPickerListener listener);
    void showIndustryPicker(String title, String okText, MarketAPI market,
                        List<Industry> industries, IndustryPickerListener listener);
    
    void makeOptionOpenCore(String optionId, CoreUITabId tabId, CoreUITradeMode mode);
    void makeOptionOpenCore(String optionId, CoreUITabId tabId, CoreUITradeMode mode, boolean onlyShowTargetTabShortcut);
    
    void setOptionColor(Object optionId, Color color);
    void makeStoryOption(Object optionId, int storyPoints, float bonusXPFraction, String soundId);
    void addOptionSelectedText(Object optionId);
    void addOptionSelectedText(Object optionId, boolean allowPrintingStoryOption);
    
    void showFleetMemberRecoveryDialog(String title, List<FleetMemberAPI> pool, FleetMemberPickerListener listener);
    void showFleetMemberRecoveryDialog(String title,
                                       List<FleetMemberAPI> pool, List<FleetMemberAPI> storyPool,
                                       FleetMemberPickerListener listener);
    void showGroundRaidTargetPicker(String title, String okText, MarketAPI market, List<GroundRaidObjectivePlugin> data, GroundRaidTargetPickerDelegate listener);
    void showVisualPanel();
    void showCustomProductionPicker(CustomProductionPickerDelegate delegate);
    void showCampaignEntityPicker(String title, String selectedText, String okText, FactionAPI factionForUIColors,
                              List<SectorEntityToken> entities, CampaignEntityPickerListener listener);
    boolean isCurrentOptionHadAConfirm();
    void showCustomVisualDialog(float customPanelWidth, float customPanelHeight, CustomVisualDialogDelegate delegate);
    void showCargoPickerDialog(String title, String okText, String cancelText, boolean small, float textPanelWidth,
            float width, float height, CargoAPI cargo, CargoPickerListener listener);
 
}