Interface PluginSettings

  • All Superinterfaces:
    BasicSettings

    public interface PluginSettings
    extends BasicSettings
    The class provides methods for reading/writing plugin settings.

    It is implemented by emuStudio. Plugins obtain this object in the constructor.

    NOTE: Keys are case-sensitive.

    Keys which are put into settings must not start with EMUSTUDIO_PREFIX. This prefix is reserved for emuStudio settings and might be overridden by emuStudio. However, there are some emuStudio settings obtainable by plugins.

    • Field Detail

      • EMUSTUDIO_PREFIX

        static final java.lang.String EMUSTUDIO_PREFIX
        EmuStudio key prefix.
        See Also:
        Constant Field Values
      • EMUSTUDIO_NO_GUI

        static final java.lang.String EMUSTUDIO_NO_GUI
        Setting key defining if emuStudio runs in "No GUI" mode.
        See Also:
        Constant Field Values
      • EMUSTUDIO_AUTO

        static final java.lang.String EMUSTUDIO_AUTO
        Setting key defining if emuStudio runs in "Auto" (non-interactive) mode.
        See Also:
        Constant Field Values
      • UNAVAILABLE

        static final PluginSettings UNAVAILABLE
        "Unavailable" instance of PluginSettings.

        It means that all methods return dummy or null values.

        The instance might be useful when creating plugin object without emuStudio (e.g. a plugin wants to support command-line interface).