Package megamek.common.options

Interface IGameOptions

All Known Implementing Classes:
AbstractOptions, BasicGameOptions, GameOptions, PartialRepairs, PilotOptions, Quirks, SBFRuleOptions, SimulationOptions, WeaponQuirks
public interface IGameOptions

  • Method Details

    • count

      int count()
      Returns a count of all options in this object.
      Returns:
      Option count.

    • count

      int count(String groupKey)
      Returns a count of all options in this object with the given group key.
      Parameters:
      groupKey - the group key to filter on. Null signifies to return all options indiscriminately.
      Returns:
      Option count.

    • getOptionList

      String getOptionList(String separator)
      Returns a string of all the quirk "codes" for this entity, using sep as the separator
      Parameters:
      separator - The separator to insert between codes, in addition to a space

    • getOptionListString

      String getOptionListString(String separator, String groupKey)
      Returns a string of all the quirk "codes" for this entity, using sep as the separator, filtering on a specific group key.
      Parameters:
      separator - The separator to insert between codes, in addition to a space
      groupKey - The group key to use to filter options. Null signifies to return all options indiscriminately.

    • getGroups

      Enumeration<IOptionGroup> getGroups()
      Returns the Enumeration of the option groups in the options container.
      Returns:
      Enumeration of the IOptionGroup

    • getOptions

      Enumeration<IOption> getOptions()
      Returns the Enumeration of the options in this options container. The order of options is not specified.
      Returns:
      Enumeration of the IOption

    • getOptionsList

      Collection<IOption> getOptionsList()
      Returns a collection of all the options in this options container, regardless of whether they're active/selected or not. Note that this Collection is unmodifiable, but the contained IOptions are not copied, so changing their state will affect this options object.
      Returns:
      A collection containing all IOptions of this options object

    • getOptionInfo

      IOptionInfo getOptionInfo(String name)
      Returns the UI specific data to allow the user to set the option
      Parameters:
      name - option name
      Returns:
      UI specific data
      See Also:

    • getOption

      @Nullable IOption getOption(String name)
      Returns the option by name or null if there is no such option
      Parameters:
      name - option name
      Returns:
      the option or null if there is no such option

    • booleanOption

      boolean booleanOption(String name)
      Returns the value of the desired option as the boolean
      Parameters:
      name - option name
      Returns:
      the value of the desired option as the boolean

    • intOption

      int intOption(String name)
      Returns the value of the desired option as the int
      Parameters:
      name - option name
      Returns:
      the value of the desired option as the int

    • floatOption

      float floatOption(String name)
      Returns the value of the desired option as the float
      Parameters:
      name - option name
      Returns:
      the value of the desired option as the float

    • stringOption

      String stringOption(String name)
      Returns the value of the desired option as the String
      Parameters:
      name - option name
      Returns:
      the value of the desired option as the String

    • getOptionsInfo

      IOptionsInfo getOptionsInfo()
      Returns the options info object for this options object.
      Returns:
      the options info object for this options object.