com.fs.starfarer.api.campaign.InteractionDialogAPI Interface Reference

Public Member Functions
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)
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)

Detailed Description

Definition at line 14 of file InteractionDialogAPI.java.

Member Function Documentation

addOptionSelectedText() [1/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.addOptionSelectedText

(

Object

optionId

)

addOptionSelectedText() [2/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.addOptionSelectedText	(	Object	optionId,
		boolean	allowPrintingStoryOption
	)

dismiss()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.dismiss

(

)

dismissAsCancel()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.dismissAsCancel

(

)

flickerStatic()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.flickerStatic	(	float	in,
		float	out
	)

getInteractionTarget()

SectorEntityToken com.fs.starfarer.api.campaign.InteractionDialogAPI.getInteractionTarget

(

)

getOptionPanel()

OptionPanelAPI com.fs.starfarer.api.campaign.InteractionDialogAPI.getOptionPanel

(

)

getPlugin()

InteractionDialogPlugin com.fs.starfarer.api.campaign.InteractionDialogAPI.getPlugin

(

)

getPromptText()

String com.fs.starfarer.api.campaign.InteractionDialogAPI.getPromptText

(

)

getTextHeight()

float com.fs.starfarer.api.campaign.InteractionDialogAPI.getTextHeight

(

)

getTextPanel()

TextPanelAPI com.fs.starfarer.api.campaign.InteractionDialogAPI.getTextPanel

(

)

getTextWidth()

float com.fs.starfarer.api.campaign.InteractionDialogAPI.getTextWidth

(

)

getVisualPanel()

VisualPanelAPI com.fs.starfarer.api.campaign.InteractionDialogAPI.getVisualPanel

(

)

getXOffset()

float com.fs.starfarer.api.campaign.InteractionDialogAPI.getXOffset

(

)

getYOffset()

float com.fs.starfarer.api.campaign.InteractionDialogAPI.getYOffset

(

)

hideTextPanel()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.hideTextPanel

(

)

hideVisualPanel()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.hideVisualPanel

(

)

isCurrentOptionHadAConfirm()

boolean com.fs.starfarer.api.campaign.InteractionDialogAPI.isCurrentOptionHadAConfirm

(

)

makeOptionOpenCore() [1/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.makeOptionOpenCore	(	String	optionId,
		CoreUITabId	tabId,
		CoreUITradeMode	mode
	)

makeOptionOpenCore() [2/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.makeOptionOpenCore	(	String	optionId,
		CoreUITabId	tabId,
		CoreUITradeMode	mode,
		boolean	onlyShowTargetTabShortcut
	)

makeStoryOption()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.makeStoryOption	(	Object	optionId,
		int	storyPoints,
		float	bonusXPFraction,
		String	soundId
	)

setBackgroundDimAmount()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setBackgroundDimAmount

(

float

backgroundDimAmount

)

setInteractionTarget()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setInteractionTarget

(

SectorEntityToken

interactionTarget

)

setOpacity()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setOpacity

(

float

opacity

)

setOptionColor()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setOptionColor	(	Object	optionId,
		Color	color
	)

setOptionOnConfirm()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setOptionOnConfirm	(	String	text,
		Object	optionId
	)

setOptionOnEscape()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.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

setPlugin()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setPlugin

(

InteractionDialogPlugin

plugin

)

setPromptText()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setPromptText

(

String

promptText

)

setTextHeight()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setTextHeight

(

float

height

)

setTextWidth()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setTextWidth

(

float

width

)

setXOffset()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setXOffset

(

float

xOffset

)

setYOffset()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.setYOffset

(

float

yOffset

)

showCampaignEntityPicker()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showCampaignEntityPicker	(	String	title,
		String	selectedText,
		String	okText,
		FactionAPI	factionForUIColors,
		List< SectorEntityToken >	entities,
		CampaignEntityPickerListener	listener
	)

showCargoPickerDialog() [1/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showCargoPickerDialog	(	String	title,
		String	okText,
		String	cancelText,
		boolean	small,
		float	textPanelWidth,
		CargoAPI	cargo,
		CargoPickerListener	listener
	)

showCargoPickerDialog() [2/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showCargoPickerDialog	(	String	title,
		String	okText,
		String	cancelText,
		boolean	small,
		float	textPanelWidth,
		float	width,
		float	height,
		CargoAPI	cargo,
		CargoPickerListener	listener
	)

showCommDirectoryDialog()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showCommDirectoryDialog

(

CommDirectoryAPI

dir

)

showCustomDialog()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showCustomDialog	(	float	customPanelWidth,
		float	customPanelHeight,
		CustomDialogDelegate	delegate
	)

showCustomProductionPicker()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showCustomProductionPicker

(

CustomProductionPickerDelegate

delegate

)

showCustomVisualDialog()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showCustomVisualDialog	(	float	customPanelWidth,
		float	customPanelHeight,
		CustomVisualDialogDelegate	delegate
	)

showFleetMemberPickerDialog()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showFleetMemberPickerDialog	(	String	title,
		String	okText,
		String	cancelText,
		int	rows,
		int	cols,
		float	iconSize,
		boolean	canPickNotReady,
		boolean	canPickMultiple,
		List< FleetMemberAPI >	pool,
		FleetMemberPickerListener	listener
	)

showFleetMemberRecoveryDialog() [1/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showFleetMemberRecoveryDialog	(	String	title,
		List< FleetMemberAPI >	pool,
		FleetMemberPickerListener	listener
	)

showFleetMemberRecoveryDialog() [2/2]

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showFleetMemberRecoveryDialog	(	String	title,
		List< FleetMemberAPI >	pool,
		List< FleetMemberAPI >	storyPool,
		FleetMemberPickerListener	listener
	)

showGroundRaidTargetPicker()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showGroundRaidTargetPicker	(	String	title,
		String	okText,
		MarketAPI	market,
		List< GroundRaidObjectivePlugin >	data,
		GroundRaidTargetPickerDelegate	listener
	)

showIndustryPicker()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showIndustryPicker	(	String	title,
		String	okText,
		MarketAPI	market,
		List< Industry >	industries,
		IndustryPickerListener	listener
	)

showTextPanel()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showTextPanel

(

)

showVisualPanel()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.showVisualPanel

(

)

startBattle()

void com.fs.starfarer.api.campaign.InteractionDialogAPI.startBattle

(

BattleCreationContext

context

)

---

The documentation for this interface was generated from the following file:

• src/com/fs/starfarer/api/campaign/InteractionDialogAPI.java