Package com.fs.starfarer.api.campaign

Interface GenericPluginManagerAPI

public interface GenericPluginManagerAPI

  • Field Details

    • CORE_GENERAL

      static final int CORE_GENERAL
      Lowest priority. Should only be used by core code, a modded plugin with this priority may not end up being used anywhere, as what gets picked when multiple plugins have the same priority is undefined.
      See Also:

    • MOD_GENERAL

      static final int MOD_GENERAL
      Should be used by mods for wholesale replacement of campaign features.
      See Also:

    • CORE_SUBSET

      static final int CORE_SUBSET
      Should only be used by core code.
      See Also:

    • MOD_SUBSET

      static final int MOD_SUBSET
      For a plugin that handles a set of circumstances. For example "interaction with all jungle worlds". Overrides any _GENERAL prioritiy implementations (i.e. "interaction with all planets"). Is overriden by _SPECIFIC priority ("interaction with this particular planet").
      See Also:

    • CORE_SPECIFIC

      static final int CORE_SPECIFIC
      Should be used by core code only for specific encounters. For example, a "special" planet or fleet could have their own dialog, and the priority of this would override a mod that replaces the general interactions with all planets or fleets.
      See Also:

    • MOD_SPECIFIC

      static final int MOD_SPECIFIC
      Should be used by mods for specific encounters, that is, encounters that aren't handled by any of the _GENERAL and _SET priority plugins. For example, if a specific fleet has a special encounter dialog, it would be returned using this priority.
      See Also:

    • HIGHEST

      static final int HIGHEST
      Absolute highest priority; shouldn't be used without good reason. A mod compilation might use this to resolve conflicts introduced by mods it contains.
      See Also:

  • Method Details