Package com.fs.starfarer.api.campaign

Interface InteractionDialogAPI

public interface InteractionDialogAPI

Method Summary

Modifier and Type	Method	Description
void	addOptionSelectedText(Object optionId)
void	addOptionSelectedText(Object optionId, boolean allowPrintingStoryOption)
void	dismiss()
void	dismissAsCancel()
void	flickerStatic(float in, float out)
SectorEntityToken	getInteractionTarget()
OptionPanelAPI	getOptionPanel()
InteractionDialogPlugin	getPlugin()
String	getPromptText()
float	getTextHeight()
TextPanelAPI	getTextPanel()
float	getTextWidth()
VisualPanelAPI	getVisualPanel()
float	getXOffset()
float	getYOffset()
void	hideTextPanel()
void	hideVisualPanel()
boolean	isCurrentOptionHadAConfirm()
void	makeOptionOpenCore(String optionId, CoreUITabId tabId, CampaignUIAPI.CoreUITradeMode mode)
void	makeOptionOpenCore(String optionId, CoreUITabId tabId, CampaignUIAPI.CoreUITradeMode mode, boolean onlyShowTargetTabShortcut)
void	makeStoryOption(Object optionId, int storyPoints, float bonusXPFraction, String soundId)
void	setBackgroundDimAmount(float backgroundDimAmount)
void	setInteractionTarget(SectorEntityToken interactionTarget)
void	setOpacity(float opacity)
void	setOptionColor(Object optionId, Color color)
void	setOptionOnConfirm(String text, Object optionId)
void	setOptionOnEscape(String text, Object optionId)	optionSelected() with these parameters will be called when the player presses "escape" while in the dialog, as the dialog is being dismissed.
void	setPlugin(InteractionDialogPlugin plugin)
void	setPromptText(String promptText)
void	setTextHeight(float height)
void	setTextWidth(float width)
void	setXOffset(float xOffset)
void	setYOffset(float yOffset)
void	showCampaignEntityPicker(String title, String selectedText, String okText, FactionAPI factionForUIColors, List<SectorEntityToken> entities, CampaignEntityPickerListener listener)
void	showCargoPickerDialog(String title, String okText, String cancelText, boolean small, float textPanelWidth, float width, float height, CargoAPI cargo, CargoPickerListener listener)
void	showCargoPickerDialog(String title, String okText, String cancelText, boolean small, float textPanelWidth, CargoAPI cargo, CargoPickerListener listener)
void	showCommDirectoryDialog(CommDirectoryAPI dir)
void	showCustomDialog(float customPanelWidth, float customPanelHeight, CustomDialogDelegate delegate)
void	showCustomProductionPicker(CustomProductionPickerDelegate delegate)
void	showCustomVisualDialog(float customPanelWidth, float customPanelHeight, CustomVisualDialogDelegate delegate)
void	showFleetMemberPickerDialog(String title, String okText, String cancelText, int rows, int cols, float iconSize, boolean canPickNotReady, boolean canPickMultiple, List<FleetMemberAPI> pool, FleetMemberPickerListener listener)
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	showIndustryPicker(String title, String okText, MarketAPI market, List<Industry> industries, IndustryPickerListener listener)
void	showTextPanel()
void	showVisualPanel()
void	startBattle(BattleCreationContext context)

Method Details

setTextWidth

void setTextWidth(float width)

setTextHeight

void setTextHeight(float height)

setXOffset

void setXOffset(float xOffset)

setYOffset

void setYOffset(float yOffset)

setPromptText

void setPromptText(String promptText)

hideTextPanel

void hideTextPanel()

showTextPanel

void showTextPanel()

getTextWidth

float getTextWidth()

getTextHeight

float getTextHeight()

getXOffset

float getXOffset()

getYOffset

float getYOffset()

getPromptText

String getPromptText()

flickerStatic

void flickerStatic(float in,
 float out)

getOptionPanel

OptionPanelAPI getOptionPanel()

getTextPanel

TextPanelAPI getTextPanel()

getVisualPanel

VisualPanelAPI getVisualPanel()

getInteractionTarget

SectorEntityToken getInteractionTarget()

getPlugin

InteractionDialogPlugin getPlugin()

setOptionOnEscape

void setOptionOnEscape(String text,
 Object optionId)

optionSelected() with these parameters will be called when the player presses "escape" while in the dialog, as the dialog is being dismissed. Can be set to null to have the escape key do nothing.

Parameters:

text -

optionId -

startBattle

void startBattle(BattleCreationContext context)

dismiss

void dismiss()

dismissAsCancel

void dismissAsCancel()

showFleetMemberPickerDialog

void showFleetMemberPickerDialog(String title,
 String okText,
 String cancelText,
 int rows,
 int cols,
 float iconSize,
 boolean canPickNotReady,
 boolean canPickMultiple,
 List<FleetMemberAPI> pool,
 FleetMemberPickerListener listener)

showCustomDialog

void showCustomDialog(float customPanelWidth,
 float customPanelHeight,
 CustomDialogDelegate delegate)

hideVisualPanel

void hideVisualPanel()

showCommDirectoryDialog

void showCommDirectoryDialog(CommDirectoryAPI dir)

setOptionOnConfirm

void setOptionOnConfirm(String text,
 Object optionId)

setOpacity

void setOpacity(float opacity)

setBackgroundDimAmount

void setBackgroundDimAmount(float backgroundDimAmount)

setPlugin

void setPlugin(InteractionDialogPlugin plugin)

setInteractionTarget

void setInteractionTarget(SectorEntityToken interactionTarget)

showCargoPickerDialog

void showCargoPickerDialog(String title,
 String okText,
 String cancelText,
 boolean small,
 float textPanelWidth,
 CargoAPI cargo,
 CargoPickerListener listener)

showIndustryPicker

void showIndustryPicker(String title,
 String okText,
 MarketAPI market,
 List<Industry> industries,
 IndustryPickerListener listener)

makeOptionOpenCore

void makeOptionOpenCore(String optionId,
 CoreUITabId tabId,
 CampaignUIAPI.CoreUITradeMode mode)

makeOptionOpenCore

void makeOptionOpenCore(String optionId,
 CoreUITabId tabId,
 CampaignUIAPI.CoreUITradeMode mode,
 boolean onlyShowTargetTabShortcut)

setOptionColor

void setOptionColor(Object optionId,
 Color color)

makeStoryOption

void makeStoryOption(Object optionId,
 int storyPoints,
 float bonusXPFraction,
 String soundId)

addOptionSelectedText

void addOptionSelectedText(Object optionId)

addOptionSelectedText

void addOptionSelectedText(Object optionId,
 boolean allowPrintingStoryOption)

showFleetMemberRecoveryDialog

void showFleetMemberRecoveryDialog(String title,
 List<FleetMemberAPI> pool,
 FleetMemberPickerListener listener)

showFleetMemberRecoveryDialog

void showFleetMemberRecoveryDialog(String title,
 List<FleetMemberAPI> pool,
 List<FleetMemberAPI> storyPool,
 FleetMemberPickerListener listener)

showGroundRaidTargetPicker

void showGroundRaidTargetPicker(String title,
 String okText,
 MarketAPI market,
 List<GroundRaidObjectivePlugin> data,
 GroundRaidTargetPickerDelegate listener)

showVisualPanel

void showVisualPanel()

showCustomProductionPicker

void showCustomProductionPicker(CustomProductionPickerDelegate delegate)

showCampaignEntityPicker

void showCampaignEntityPicker(String title,
 String selectedText,
 String okText,
 FactionAPI factionForUIColors,
 List<SectorEntityToken> entities,
 CampaignEntityPickerListener listener)

isCurrentOptionHadAConfirm

boolean isCurrentOptionHadAConfirm()

showCustomVisualDialog

void showCustomVisualDialog(float customPanelWidth,
 float customPanelHeight,
 CustomVisualDialogDelegate delegate)

showCargoPickerDialog

void showCargoPickerDialog(String title,
 String okText,
 String cancelText,
 boolean small,
 float textPanelWidth,
 float width,
 float height,
 CargoAPI cargo,
 CargoPickerListener listener)