CampaignUIAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.util.List;
 
import java.awt.Color;
 
import com.fs.starfarer.api.Script;
import com.fs.starfarer.api.campaign.comm.CommMessageAPI.MessageClickAction;
import com.fs.starfarer.api.campaign.comm.IntelInfoPlugin;
import com.fs.starfarer.api.combat.BattleCreationContext;
import com.fs.starfarer.api.loading.HullModSpecAPI;
import com.fs.starfarer.api.ui.HintPanelAPI;
import com.fs.starfarer.api.util.FaderUtil;
 
public interface CampaignUIAPI {
    public static enum CoreUITradeMode {
        OPEN,
        SNEAK,
        NONE,
    }
    
    public static interface DismissDialogDelegate {
        void dialogDismissed();
    }
    
    MessageDisplayAPI getMessageDisplay();
    
    void addMessage(String text);
    void addMessage(String text, Color color);
    void addMessage(String text, Color color, String h1, String h2, Color hc1, Color hc2);
    
    void clearMessages();
    
    boolean isShowingDialog();
    void startBattle(BattleCreationContext context);
    
    boolean showInteractionDialog(InteractionDialogPlugin plugin, SectorEntityToken interactionTarget);
    
    
    boolean showInteractionDialog(SectorEntityToken interactionTarget);
    
    
    void showCoreUITab(CoreUITabId tab);
    
    void showCoreUITab(CoreUITabId tab, Object custom);
    
    InteractionDialogAPI getCurrentInteractionDialog();
 
    void setDisallowPlayerInteractionsForOneFrame();
 
    FaderUtil getSharedFader();
 
    //void suppressMusic();
 
    float getZoomFactor();
 
    void suppressMusic(float maxLevel);
 
    boolean isShowingMenu();
 
    void resetViewOffset();
 
    List<HullModSpecAPI> getAvailableHullModsCopy();
 
    boolean isHullModAvailable(String id);
 
    List<String> getAvailableHullModIds();
 
    HintPanelAPI getHintPanel();
 
    void quickLoad();
 
    CoreUITabId getCurrentCoreTab();
 
    void cmdExitWithoutSaving();
    boolean cmdSaveAndExit();
    void cmdSettings();
    void cmdSaveCopy();
    boolean cmdSave();
    void cmdLoad();
    void cmdCodex();
 
    boolean showConfirmDialog(String message, String ok, String cancel, Script onOk, Script onCancel);
    boolean showConfirmDialog(String message, String ok, String cancel, float width, float height, Script onOk, Script onCancel);
 
    void addMessage(IntelInfoPlugin intel);
    void addMessage(IntelInfoPlugin intel, MessageClickAction action);
    void addMessage(IntelInfoPlugin intel, MessageClickAction action, Object custom);
 
    void setFollowingDirectCommand(boolean followingDirectCommand);
    boolean isFollowingDirectCommand();
 
    void clearLaidInCourse();
 
    boolean showPlayerFactionConfigDialog();
 
    void showHelpPopupIfPossible(String id);
 
    SectorEntityToken getUltimateCourseTarget();
    SectorEntityToken getCurrentCourseTarget();
    SectorEntityToken getNextStepForCourse(SectorEntityToken courseTarget);
    void layInCourseForNextStep(SectorEntityToken courseTarget);
    String getNameForCourseTarget(SectorEntityToken entity, boolean isEndpoint);
    float getLastLegDistance(SectorEntityToken courseTarget);
 
    boolean isFastForward();
 
    boolean isPlayerFleetFollowingMouse();
 
    void showMessageDialog(String message);
 
    float getMinZoomFactor();
    float getMaxZoomFactor();
    void setMinZoomFactor(float min);
    void setMaxZoomFactor(float max);
 
    boolean isSuppressFuelRangeRenderingOneFrame();
    void setSuppressFuelRangeRenderingOneFrame(boolean suppressFuelRangeRenderingOneFrame);
 
    int getMaxIntelMapIcons();
    void setMaxIntelMapIcons(int maxIntelMapIcons);
 
    boolean isHideUI();
    void setHideUI(boolean hideUI);
 
    void setZoomFactor(float zoomFactor);
 
    void autosave();
 
    boolean showInteractionDialogFromCargo(InteractionDialogPlugin plugin, SectorEntityToken interactionTarget, DismissDialogDelegate delegate);
 
    void restartEncounterMusic(SectorEntityToken interactionTarget);
 
 
}