Package com.fs.starfarer.api.campaign

Interface CampaignUIAPI

public interface CampaignUIAPI

  • Method Details

    • getMessageDisplay

      MessageDisplayAPI getMessageDisplay()

    • addMessage

      void addMessage(String text)

    • addMessage

      void addMessage(String text, Color color)

    • addMessage

      void addMessage(String text, Color color, String h1, String h2, Color hc1, Color hc2)

    • clearMessages

      void clearMessages()

    • isShowingDialog

      boolean isShowingDialog()

    • startBattle

      void startBattle(BattleCreationContext context)

    • showInteractionDialog

      boolean showInteractionDialog(InteractionDialogPlugin plugin, SectorEntityToken interactionTarget)
      Returns true if dialog was actually shown, false otherwise (if, for example, UI is already showing another dialog).
      Parameters:
      plugin -
      interactionTarget - can be null.

    • showInteractionDialog

      boolean showInteractionDialog(SectorEntityToken interactionTarget)
      Returns true if dialog was actually shown, false otherwise (if, for example, UI is already showing another dialog). Picks whatever dialog is appropriate based on the various plugins that provide dialog implementations.
      Parameters:
      interactionTarget -

    • showCoreUITab

      void showCoreUITab(CoreUITabId tab)

    • showCoreUITab

      void showCoreUITab(CoreUITabId tab, Object custom)
      Parameters:
      tab -
      custom - IntelInfoPlugin to select in intel tab, or FleetMemberAPI to select in refit tab

    • getCurrentInteractionDialog

      InteractionDialogAPI getCurrentInteractionDialog()

    • setDisallowPlayerInteractionsForOneFrame

      void setDisallowPlayerInteractionsForOneFrame()

    • getSharedFader

      FaderUtil getSharedFader()

    • getZoomFactor

      float getZoomFactor()

    • suppressMusic

      void suppressMusic(float maxLevel)

    • isShowingMenu

      boolean isShowingMenu()

    • resetViewOffset

      void resetViewOffset()

    • getAvailableHullModsCopy

      List<HullModSpecAPI> getAvailableHullModsCopy()

    • isHullModAvailable

      boolean isHullModAvailable(String id)

    • getAvailableHullModIds

      List<String> getAvailableHullModIds()

    • getHintPanel

      HintPanelAPI getHintPanel()

    • quickLoad

      void quickLoad()

    • getCurrentCoreTab

      CoreUITabId getCurrentCoreTab()

    • cmdExitWithoutSaving

      void cmdExitWithoutSaving()

    • cmdSaveAndExit

      boolean cmdSaveAndExit()

    • cmdSettings

      void cmdSettings()

    • cmdSaveCopy

      void cmdSaveCopy()

    • cmdSave

      boolean cmdSave()

    • cmdLoad

      void cmdLoad()

    • cmdCodex

      void cmdCodex()

    • showConfirmDialog

      boolean showConfirmDialog(String message, String ok, String cancel, Script onOk, Script onCancel)

    • showConfirmDialog

      boolean showConfirmDialog(String message, String ok, String cancel, float width, float height, Script onOk, Script onCancel)

    • addMessage

      void addMessage(IntelInfoPlugin intel)

    • addMessage

      void addMessage(IntelInfoPlugin intel, CommMessageAPI.MessageClickAction action)

    • addMessage

      void addMessage(IntelInfoPlugin intel, CommMessageAPI.MessageClickAction action, Object custom)

    • setFollowingDirectCommand

      void setFollowingDirectCommand(boolean followingDirectCommand)

    • isFollowingDirectCommand

      boolean isFollowingDirectCommand()

    • clearLaidInCourse

      void clearLaidInCourse()

    • showPlayerFactionConfigDialog

      boolean showPlayerFactionConfigDialog()
      Returns:
      true if was shown (may not be if showing another dialog etc)

    • showHelpPopupIfPossible

      void showHelpPopupIfPossible(String id)

    • getUltimateCourseTarget

      SectorEntityToken getUltimateCourseTarget()
      Calls Global.getSector().getUIData().getCourseTarget(). The actual ultimate autopilot destination, not its next step.
      Returns:

    • getCurrentCourseTarget

      SectorEntityToken getCurrentCourseTarget()

    • getNextStepForCourse

      SectorEntityToken getNextStepForCourse(SectorEntityToken courseTarget)

    • layInCourseForNextStep

      void layInCourseForNextStep(SectorEntityToken courseTarget)

    • getNameForCourseTarget

      String getNameForCourseTarget(SectorEntityToken entity, boolean isEndpoint)

    • getLastLegDistance

      float getLastLegDistance(SectorEntityToken courseTarget)

    • isFastForward

      boolean isFastForward()

    • isPlayerFleetFollowingMouse

      boolean isPlayerFleetFollowingMouse()

    • showMessageDialog

      void showMessageDialog(String message)

    • getMinZoomFactor

      float getMinZoomFactor()

    • getMaxZoomFactor

      float getMaxZoomFactor()

    • setMinZoomFactor

      void setMinZoomFactor(float min)

    • setMaxZoomFactor

      void setMaxZoomFactor(float max)

    • isSuppressFuelRangeRenderingOneFrame

      boolean isSuppressFuelRangeRenderingOneFrame()

    • setSuppressFuelRangeRenderingOneFrame

      void setSuppressFuelRangeRenderingOneFrame(boolean suppressFuelRangeRenderingOneFrame)

    • getMaxIntelMapIcons

      int getMaxIntelMapIcons()

    • setMaxIntelMapIcons

      void setMaxIntelMapIcons(int maxIntelMapIcons)

    • isHideUI

      boolean isHideUI()

    • setHideUI

      void setHideUI(boolean hideUI)

    • setZoomFactor

      void setZoomFactor(float zoomFactor)

    • autosave

      void autosave()
      If the game is currently showing a dialog of any ort: does not do anything.

    • showInteractionDialogFromCargo

      boolean showInteractionDialogFromCargo(InteractionDialogPlugin plugin, SectorEntityToken interactionTarget, CampaignUIAPI.DismissDialogDelegate delegate)

    • restartEncounterMusic

      void restartEncounterMusic(SectorEntityToken interactionTarget)