Package com.fs.starfarer.api.campaign

Interface OptionPanelAPI

public interface OptionPanelAPI

  • Method Details

    • setTooltipHighlights

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

    • setTooltipHighlightColors

      void setTooltipHighlightColors(Object data, Color... colors)

    • clearOptions

      void clearOptions()

    • addOption

      void addOption(String text, Object data)

    • addOption

      void addOption(String text, Object data, String tooltip)

    • addOption

      void addOption(String text, Object data, Color color, String tooltip)

    • setShortcut

      void 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

    • setEnabled

      void setEnabled(Object data, boolean enabled)
      Only works for options, not selectors.
      Parameters:
      data -
      enabled -

    • setTooltip

      void setTooltip(Object data, String tooltipText)

    • addSelector

      void 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.

    • hasSelector

      boolean hasSelector(Object data)

    • setSelectorValue

      void setSelectorValue(Object data, float value)

    • getSelectorValue

      float getSelectorValue(Object data)

    • getMinSelectorValue

      float getMinSelectorValue(Object data)

    • getMaxSelectorValue

      float getMaxSelectorValue(Object data)

    • hasOptions

      boolean hasOptions()

    • getSavedOptionList

      List getSavedOptionList()

    • restoreSavedOptions

      void restoreSavedOptions(List list)

    • addOptionConfirmation

      void addOptionConfirmation(Object optionId, String text, String yes, String no)

    • hasOption

      boolean hasOption(Object data)

    • addOptionConfirmation

      void addOptionConfirmation(Object data, StoryPointActionDelegate confirmDelegate)

    • addOptionTooltipAppender

      void addOptionTooltipAppender(Object data, OptionPanelAPI.OptionTooltipCreator optionTooltipCreator)

    • setOptionText

      void setOptionText(String text, Object data)

    • hasOptionTooltipAppender

      boolean hasOptionTooltipAppender(Object data)

    • optionHasConfirmDelegate

      boolean optionHasConfirmDelegate(Object data)

    • getOptionDataBeingConfirmed

      Object getOptionDataBeingConfirmed()

    • removeOption

      void removeOption(Object data)

    • setStoryOptionParams

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