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

Classes
interface	OptionTooltipCreator

Public Member Functions
void	setTooltipHighlights (Object data, String ... highlights)
void	setTooltipHighlightColors (Object data, Color ... colors)
void	clearOptions ()
void	addOption (String text, Object data)
void	addOption (String text, Object data, String tooltip)
void	addOption (String text, Object data, Color color, String tooltip)
void	setShortcut (Object data, int code, boolean ctrl, boolean alt, boolean shift, boolean putLast)
void	setEnabled (Object data, boolean enabled)
void	setTooltip (Object data, String tooltipText)
void	addSelector (String text, Object data, Color color, float width, float maxValueWidth, float minValue, float maxValue, ValueDisplayMode mode, String tooltip)
boolean	hasSelector (Object data)
void	setSelectorValue (Object data, float value)
float	getSelectorValue (Object data)
float	getMinSelectorValue (Object data)
float	getMaxSelectorValue (Object data)
boolean	hasOptions ()
List	getSavedOptionList ()
void	restoreSavedOptions (List list)
void	addOptionConfirmation (Object optionId, String text, String yes, String no)
boolean	hasOption (Object data)
void	addOptionConfirmation (Object data, StoryPointActionDelegate confirmDelegate)
void	addOptionTooltipAppender (Object data, OptionTooltipCreator optionTooltipCreator)
void	setOptionText (String text, Object data)
boolean	hasOptionTooltipAppender (Object data)
boolean	optionHasConfirmDelegate (Object data)
Object	getOptionDataBeingConfirmed ()
void	removeOption (Object data)
void	setStoryOptionParams (Object data, StoryOptionParams params, StoryPointActionDelegate delegate)

Detailed Description

Definition at line 11 of file OptionPanelAPI.java.

Member Function Documentation

addOption() [1/3]

void com.fs.starfarer.api.campaign.OptionPanelAPI.addOption	(	String	text,
		Object	data
	)

addOption() [2/3]

void com.fs.starfarer.api.campaign.OptionPanelAPI.addOption	(	String	text,
		Object	data,
		Color	color,
		String	tooltip
	)

addOption() [3/3]

void com.fs.starfarer.api.campaign.OptionPanelAPI.addOption	(	String	text,
		Object	data,
		String	tooltip
	)

addOptionConfirmation() [1/2]

void com.fs.starfarer.api.campaign.OptionPanelAPI.addOptionConfirmation	(	Object	data,
		StoryPointActionDelegate	confirmDelegate
	)

addOptionConfirmation() [2/2]

void com.fs.starfarer.api.campaign.OptionPanelAPI.addOptionConfirmation	(	Object	optionId,
		String	text,
		String	yes,
		String	no
	)

addOptionTooltipAppender()

void com.fs.starfarer.api.campaign.OptionPanelAPI.addOptionTooltipAppender	(	Object	data,
		OptionTooltipCreator	optionTooltipCreator
	)

addSelector()

void com.fs.starfarer.api.campaign.OptionPanelAPI.addSelector	(	String	text,
		Object	data,
		Color	color,
		float	width,
		float	maxValueWidth,
		float	minValue,
		float	maxValue,
		ValueDisplayMode	mode,
		String	tooltip
	)

A user-adjustable bar useful for picking a value from a range.

Parameters

text	Text to show above the bar.
data	ID of the bar, used to get/set its state.
color	Bar color.
width	Width in pixels, including value label on the right.
maxValueWidth	Width of the value label on the right.
minValue	Minimum value (when bar is all the way to the left).
maxValue	Maximum value (bar all the way to the right).
mode	How to display the value - as a percentage, X/Y, etc.
tooltip	Tooltip text. Can be null.

clearOptions()

void com.fs.starfarer.api.campaign.OptionPanelAPI.clearOptions

(

)

getMaxSelectorValue()

float com.fs.starfarer.api.campaign.OptionPanelAPI.getMaxSelectorValue

(

Object

data

)

getMinSelectorValue()

float com.fs.starfarer.api.campaign.OptionPanelAPI.getMinSelectorValue

(

Object

data

)

getOptionDataBeingConfirmed()

Object com.fs.starfarer.api.campaign.OptionPanelAPI.getOptionDataBeingConfirmed

(

)

getSavedOptionList()

List com.fs.starfarer.api.campaign.OptionPanelAPI.getSavedOptionList

(

)

getSelectorValue()

float com.fs.starfarer.api.campaign.OptionPanelAPI.getSelectorValue

(

Object

data

)

hasOption()

boolean com.fs.starfarer.api.campaign.OptionPanelAPI.hasOption

(

Object

data

)

hasOptions()

boolean com.fs.starfarer.api.campaign.OptionPanelAPI.hasOptions

(

)

hasOptionTooltipAppender()

boolean com.fs.starfarer.api.campaign.OptionPanelAPI.hasOptionTooltipAppender

(

Object

data

)

hasSelector()

boolean com.fs.starfarer.api.campaign.OptionPanelAPI.hasSelector

(

Object

data

)

optionHasConfirmDelegate()

boolean com.fs.starfarer.api.campaign.OptionPanelAPI.optionHasConfirmDelegate

(

Object

data

)

removeOption()

void com.fs.starfarer.api.campaign.OptionPanelAPI.removeOption

(

Object

data

)

restoreSavedOptions()

void com.fs.starfarer.api.campaign.OptionPanelAPI.restoreSavedOptions

(

List

list

)

setEnabled()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setEnabled	(	Object	data,
		boolean	enabled
	)

Only works for options, not selectors.

Parameters

data
enabled

setOptionText()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setOptionText	(	String	text,
		Object	data
	)

setSelectorValue()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setSelectorValue	(	Object	data,
		float	value
	)

setShortcut()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setShortcut	(	Object	data,
		int	code,
		boolean	ctrl,
		boolean	alt,
		boolean	shift,
		boolean	putLast
	)

Sets an alternate shortcut that works in addition to the number key.

Parameters

data
code	constant from org.lwjgl.input.Keyboard
ctrl	whether Control needs to be down to trigger this shortcut.
alt	whether Alt needs to be down to trigger this shortcut.
shift	whether Shift needs to be down to trigger this shortcut.
putLast	ignored

setStoryOptionParams()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setStoryOptionParams	(	Object	data,
		StoryOptionParams	params,
		StoryPointActionDelegate	delegate
	)

setTooltip()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setTooltip	(	Object	data,
		String	tooltipText
	)

setTooltipHighlightColors()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setTooltipHighlightColors	(	Object	data,
		Color ...	colors
	)

setTooltipHighlights()

void com.fs.starfarer.api.campaign.OptionPanelAPI.setTooltipHighlights	(	Object	data,
		String ...	highlights
	)

---

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

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