Package mekhq.gui.preferences

Class PreferenceFlags

java.lang.Object
mekhq.gui.preferences.PreferenceFlags
public final class PreferenceFlags extends Object
A set of named on/off settings stored under one preferences node, such as a window's tutorial flags.

Each flag is saved in the preferences file as true or false. A flag that was never registered, or failed to register, reads as false and ignores writes.

Since:
0.51.01

  • Constructor Details

    • PreferenceFlags

      public PreferenceFlags(megamek.client.ui.preferences.PreferencesNode node)
      Parameters:
      node - the preferences node to store the flags under

  • Method Details

    • register

      public void register(String name, boolean defaultValue)
      Adds a flag, loading any value saved in an earlier session; it is saved again on exit.
      Parameters:
      name - the flag's name in the preferences file
      defaultValue - the value before anything has been saved

    • get

      public boolean get(String name)
      Parameters:
      name - the flag's name
      Returns:
      the flag's value, or false if it isn't registered

    • set

      public void set(String name, boolean value)
      Parameters:
      name - the flag's name
      value - the new value, ignored if the flag isn't registered