com.fs.starfarer.api.campaign

Interface OptionPanelAPI

public interface OptionPanelAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OptionPanelAPI.OptionTooltipCreator

Method Summary

Modifier and Type	Method and Description
void	addOption(java.lang.String text, java.lang.Object data) Adds an additional selectable option to the dialog.
void	addOption(java.lang.String text, java.lang.Object data, java.awt.Color color, java.lang.String tooltip)
void	addOption(java.lang.String text, java.lang.Object data, java.lang.String tooltip)
void	addOptionConfirmation(java.lang.Object data, StoryPointActionDelegate confirmDelegate) This is what you want to use to add a story point option to a dialog.
void	addOptionConfirmation(java.lang.Object optionId, java.lang.String text, java.lang.String yes, java.lang.String no)
void	addOptionTooltipAppender(java.lang.Object data, OptionPanelAPI.OptionTooltipCreator optionTooltipCreator)
void	addSelector(java.lang.String text, java.lang.Object data, java.awt.Color color, float width, float maxValueWidth, float minValue, float maxValue, ValueDisplayMode mode, java.lang.String tooltip) A user-adjustable bar useful for picking a value from a range.
void	clearOptions()
float	getMaxSelectorValue(java.lang.Object data)
float	getMinSelectorValue(java.lang.Object data)
java.lang.Object	getOptionDataBeingConfirmed()
java.util.List	getSavedOptionList()
float	getSelectorValue(java.lang.Object data)
boolean	hasOption(java.lang.Object data)
boolean	hasOptions()
boolean	hasOptionTooltipAppender(java.lang.Object data)
boolean	hasSelector(java.lang.Object data)
boolean	optionHasConfirmDelegate(java.lang.Object data)
void	removeOption(java.lang.Object data)
void	restoreSavedOptions(java.util.List list)
void	setEnabled(java.lang.Object data, boolean enabled) Only works for options, not selectors.
void	setOptionText(java.lang.String text, java.lang.Object data)
void	setSelectorValue(java.lang.Object data, float value)
void	setShortcut(java.lang.Object data, int code, boolean ctrl, boolean alt, boolean shift, boolean putLast) Sets an alternate shortcut that works in addition to the number key.
void	setStoryOptionParams(java.lang.Object data, SetStoryOption.StoryOptionParams params, StoryPointActionDelegate delegate) Calling this will not do everything neccessary to turn an option into a story point option.
void	setTooltip(java.lang.Object data, java.lang.String tooltipText)
void	setTooltipHighlightColors(java.lang.Object data, java.awt.Color... colors)
void	setTooltipHighlights(java.lang.Object data, java.lang.String... highlights)

Method Detail

setTooltipHighlights

void setTooltipHighlights(java.lang.Object data,
                          java.lang.String... highlights)

setTooltipHighlightColors

void setTooltipHighlightColors(java.lang.Object data,
                               java.awt.Color... colors)

clearOptions

void clearOptions()

addOption

void addOption(java.lang.String text,
               java.lang.Object data)

Adds an additional selectable option to the dialog. Options are appended in the order that this method is called. It usually makes sense to call clearOptions() before adding options to ensure that options don't pile up.

Parameters:

text - will be displayed in the option list

data - can be anything. This is used to identify the option, i.e. other methods that modify options need you to pass the exact same thing you pass here. People often times use Strings or enums as option data. Alternatively, you can use objects that implement an interface with e.g. an execute-method, to make the option data directly contain the logic that should be executed when the option is selected by the player. The value passed here is available in the optionSelected method of InteractionDialogPlugin. Cast the optionData parameter to the type you used here to evaluate it.

addOption

void addOption(java.lang.String text,
               java.lang.Object data,
               java.lang.String tooltip)

addOption

void addOption(java.lang.String text,
               java.lang.Object data,
               java.awt.Color color,
               java.lang.String tooltip)

setShortcut

void setShortcut(java.lang.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

setEnabled

void setEnabled(java.lang.Object data,
                boolean enabled)

Only works for options, not selectors.

Parameters:

data -

enabled -

setTooltip

void setTooltip(java.lang.Object data,
                java.lang.String tooltipText)

addSelector

void addSelector(java.lang.String text,
                 java.lang.Object data,
                 java.awt.Color color,
                 float width,
                 float maxValueWidth,
                 float minValue,
                 float maxValue,
                 ValueDisplayMode mode,
                 java.lang.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.

hasSelector

boolean hasSelector(java.lang.Object data)

setSelectorValue

void setSelectorValue(java.lang.Object data,
                      float value)

getSelectorValue

float getSelectorValue(java.lang.Object data)

getMinSelectorValue

float getMinSelectorValue(java.lang.Object data)

getMaxSelectorValue

float getMaxSelectorValue(java.lang.Object data)

hasOptions

boolean hasOptions()

getSavedOptionList

java.util.List getSavedOptionList()

restoreSavedOptions

void restoreSavedOptions(java.util.List list)

addOptionConfirmation

void addOptionConfirmation(java.lang.Object optionId,
                           java.lang.String text,
                           java.lang.String yes,
                           java.lang.String no)

hasOption

boolean hasOption(java.lang.Object data)

addOptionConfirmation

void addOptionConfirmation(java.lang.Object data,
                           StoryPointActionDelegate confirmDelegate)

This is what you want to use to add a story point option to a dialog. Using this method will handle everything a story option needs (story point cost, confirmation, ...), though you will need to set the color of the option manually. The alternative to using this method is to use SetStoryOption.

Example:

 
    // given an object of type OptionPanelAPI named options
        options.addOption("My story option [1SP, 0% XP]", "myData (can be any type)", Misc.getStoryOptionColor(), "tooltip (can be null)");
        options.addOptionConfirmation(
                "myData (can be any type)",
                new BaseStoryPointActionDelegate() {
                         @Override
                        public String getLogText(){ return "this appears in the log"; }
                         @Override
                        public int getRequiredStoryPoints(){ return 1; }
                         @Override
                        public float getBonusXPFraction(){ return 0f; } // a value between 0 and 1. 1 Means 100% bonus XP
                         @Override
                        public boolean withSPInfo(){ return true; }
                         @Override
                        public String getTitle(){ return "title to display in confirmation box"; }
                         @Override
                        public void createDescription(TooltipMakerAPI info){ info.addPara("description text in confirmation box", 1f); }
                }
        );
 
 

Parameters:

data - must be the same thing you passed to addOption

confirmDelegate - an object implementing the StoryPointActionDelegate interface. cf. example

addOptionTooltipAppender

void addOptionTooltipAppender(java.lang.Object data,
                              OptionPanelAPI.OptionTooltipCreator optionTooltipCreator)

setOptionText

void setOptionText(java.lang.String text,
                   java.lang.Object data)

hasOptionTooltipAppender

boolean hasOptionTooltipAppender(java.lang.Object data)

optionHasConfirmDelegate

boolean optionHasConfirmDelegate(java.lang.Object data)

getOptionDataBeingConfirmed

java.lang.Object getOptionDataBeingConfirmed()

removeOption

void removeOption(java.lang.Object data)

setStoryOptionParams

void setStoryOptionParams(java.lang.Object data,
                          SetStoryOption.StoryOptionParams params,
                          StoryPointActionDelegate delegate)

Calling this will not do everything neccessary to turn an option into a story point option. Use addOptionConfirmation instead. I believe this method is only used to modify existing story options. This method needs additional documentation, as I am not 100% sure what its purpose is.

Parameters:

data - identifier for the option

params -

delegate -