Starsector API
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
com.fs.starfarer.api.campaign.CampaignUIAPI Interface Reference

Classes

enum  CoreUITradeMode
 
interface  DismissDialogDelegate
 

Public Member Functions

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 ()
 
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)
 

Detailed Description

Definition at line 15 of file CampaignUIAPI.java.

Member Function Documentation

◆ addMessage() [1/6]

void com.fs.starfarer.api.campaign.CampaignUIAPI.addMessage ( IntelInfoPlugin intel)

◆ addMessage() [2/6]

void com.fs.starfarer.api.campaign.CampaignUIAPI.addMessage ( IntelInfoPlugin intel,
MessageClickAction action )

◆ addMessage() [3/6]

void com.fs.starfarer.api.campaign.CampaignUIAPI.addMessage ( IntelInfoPlugin intel,
MessageClickAction action,
Object custom )

◆ addMessage() [4/6]

void com.fs.starfarer.api.campaign.CampaignUIAPI.addMessage ( String text)

◆ addMessage() [5/6]

void com.fs.starfarer.api.campaign.CampaignUIAPI.addMessage ( String text,
Color color )

◆ addMessage() [6/6]

void com.fs.starfarer.api.campaign.CampaignUIAPI.addMessage ( String text,
Color color,
String h1,
String h2,
Color hc1,
Color hc2 )

◆ autosave()

void com.fs.starfarer.api.campaign.CampaignUIAPI.autosave ( )

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

◆ clearLaidInCourse()

void com.fs.starfarer.api.campaign.CampaignUIAPI.clearLaidInCourse ( )

◆ clearMessages()

void com.fs.starfarer.api.campaign.CampaignUIAPI.clearMessages ( )

◆ cmdCodex()

void com.fs.starfarer.api.campaign.CampaignUIAPI.cmdCodex ( )

◆ cmdExitWithoutSaving()

void com.fs.starfarer.api.campaign.CampaignUIAPI.cmdExitWithoutSaving ( )

◆ cmdLoad()

void com.fs.starfarer.api.campaign.CampaignUIAPI.cmdLoad ( )

◆ cmdSave()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.cmdSave ( )

◆ cmdSaveAndExit()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.cmdSaveAndExit ( )

◆ cmdSaveCopy()

void com.fs.starfarer.api.campaign.CampaignUIAPI.cmdSaveCopy ( )

◆ cmdSettings()

void com.fs.starfarer.api.campaign.CampaignUIAPI.cmdSettings ( )

◆ getAvailableHullModIds()

List< String > com.fs.starfarer.api.campaign.CampaignUIAPI.getAvailableHullModIds ( )

◆ getAvailableHullModsCopy()

List< HullModSpecAPI > com.fs.starfarer.api.campaign.CampaignUIAPI.getAvailableHullModsCopy ( )

◆ getCurrentCoreTab()

CoreUITabId com.fs.starfarer.api.campaign.CampaignUIAPI.getCurrentCoreTab ( )

◆ getCurrentCourseTarget()

SectorEntityToken com.fs.starfarer.api.campaign.CampaignUIAPI.getCurrentCourseTarget ( )

◆ getCurrentInteractionDialog()

InteractionDialogAPI com.fs.starfarer.api.campaign.CampaignUIAPI.getCurrentInteractionDialog ( )

◆ getHintPanel()

HintPanelAPI com.fs.starfarer.api.campaign.CampaignUIAPI.getHintPanel ( )

◆ getLastLegDistance()

float com.fs.starfarer.api.campaign.CampaignUIAPI.getLastLegDistance ( SectorEntityToken courseTarget)

◆ getMaxIntelMapIcons()

int com.fs.starfarer.api.campaign.CampaignUIAPI.getMaxIntelMapIcons ( )

◆ getMaxZoomFactor()

float com.fs.starfarer.api.campaign.CampaignUIAPI.getMaxZoomFactor ( )

◆ getMessageDisplay()

MessageDisplayAPI com.fs.starfarer.api.campaign.CampaignUIAPI.getMessageDisplay ( )

◆ getMinZoomFactor()

float com.fs.starfarer.api.campaign.CampaignUIAPI.getMinZoomFactor ( )

◆ getNameForCourseTarget()

String com.fs.starfarer.api.campaign.CampaignUIAPI.getNameForCourseTarget ( SectorEntityToken entity,
boolean isEndpoint )

◆ getNextStepForCourse()

SectorEntityToken com.fs.starfarer.api.campaign.CampaignUIAPI.getNextStepForCourse ( SectorEntityToken courseTarget)

◆ getSharedFader()

FaderUtil com.fs.starfarer.api.campaign.CampaignUIAPI.getSharedFader ( )

◆ getUltimateCourseTarget()

SectorEntityToken com.fs.starfarer.api.campaign.CampaignUIAPI.getUltimateCourseTarget ( )

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

Returns

◆ getZoomFactor()

float com.fs.starfarer.api.campaign.CampaignUIAPI.getZoomFactor ( )

◆ isFastForward()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isFastForward ( )

◆ isFollowingDirectCommand()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isFollowingDirectCommand ( )

◆ isHideUI()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isHideUI ( )

◆ isHullModAvailable()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isHullModAvailable ( String id)

◆ isPlayerFleetFollowingMouse()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isPlayerFleetFollowingMouse ( )

◆ isShowingDialog()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isShowingDialog ( )

◆ isShowingMenu()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isShowingMenu ( )

◆ isSuppressFuelRangeRenderingOneFrame()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.isSuppressFuelRangeRenderingOneFrame ( )

◆ layInCourseForNextStep()

void com.fs.starfarer.api.campaign.CampaignUIAPI.layInCourseForNextStep ( SectorEntityToken courseTarget)

◆ quickLoad()

void com.fs.starfarer.api.campaign.CampaignUIAPI.quickLoad ( )

◆ resetViewOffset()

void com.fs.starfarer.api.campaign.CampaignUIAPI.resetViewOffset ( )

◆ restartEncounterMusic()

void com.fs.starfarer.api.campaign.CampaignUIAPI.restartEncounterMusic ( SectorEntityToken interactionTarget)

◆ setDisallowPlayerInteractionsForOneFrame()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setDisallowPlayerInteractionsForOneFrame ( )

◆ setFollowingDirectCommand()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setFollowingDirectCommand ( boolean followingDirectCommand)

◆ setHideUI()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setHideUI ( boolean hideUI)

◆ setMaxIntelMapIcons()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setMaxIntelMapIcons ( int maxIntelMapIcons)

◆ setMaxZoomFactor()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setMaxZoomFactor ( float max)

◆ setMinZoomFactor()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setMinZoomFactor ( float min)

◆ setSuppressFuelRangeRenderingOneFrame()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setSuppressFuelRangeRenderingOneFrame ( boolean suppressFuelRangeRenderingOneFrame)

◆ setZoomFactor()

void com.fs.starfarer.api.campaign.CampaignUIAPI.setZoomFactor ( float zoomFactor)

◆ showConfirmDialog() [1/2]

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.showConfirmDialog ( String message,
String ok,
String cancel,
float width,
float height,
Script onOk,
Script onCancel )

◆ showConfirmDialog() [2/2]

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.showConfirmDialog ( String message,
String ok,
String cancel,
Script onOk,
Script onCancel )

◆ showCoreUITab() [1/2]

void com.fs.starfarer.api.campaign.CampaignUIAPI.showCoreUITab ( CoreUITabId tab)

◆ showCoreUITab() [2/2]

void com.fs.starfarer.api.campaign.CampaignUIAPI.showCoreUITab ( CoreUITabId tab,
Object custom )
Parameters
tab
customIntelInfoPlugin to select in intel tab, or FleetMemberAPI to select in refit tab

◆ showHelpPopupIfPossible()

void com.fs.starfarer.api.campaign.CampaignUIAPI.showHelpPopupIfPossible ( String id)

◆ showInteractionDialog() [1/2]

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.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
interactionTargetcan be null.

◆ showInteractionDialog() [2/2]

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.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

◆ showInteractionDialogFromCargo()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.showInteractionDialogFromCargo ( InteractionDialogPlugin plugin,
SectorEntityToken interactionTarget,
DismissDialogDelegate delegate )

◆ showMessageDialog()

void com.fs.starfarer.api.campaign.CampaignUIAPI.showMessageDialog ( String message)

◆ showPlayerFactionConfigDialog()

boolean com.fs.starfarer.api.campaign.CampaignUIAPI.showPlayerFactionConfigDialog ( )
Returns
true if was shown (may not be if showing another dialog etc)

◆ startBattle()

void com.fs.starfarer.api.campaign.CampaignUIAPI.startBattle ( BattleCreationContext context)

◆ suppressMusic()

void com.fs.starfarer.api.campaign.CampaignUIAPI.suppressMusic ( float maxLevel)
The documentation for this interface was generated from the following file: