Package mindustry.mod

Class Mods

java.lang.Object
mindustry.mod.Mods
All Implemented Interfaces:
arc.assets.Loadable
public class Mods extends Object implements arc.assets.Loadable

  • Constructor Details

    • Mods

      public Mods()

  • Method Details

    • mainLoader

      public ClassLoader mainLoader()
      Returns:
      the main class loader for all mods

    • getConfigFolder

      public arc.files.Fi getConfigFolder(Mod mod)
      Returns:
      the folder where configuration files for this mod should go. Call this in init().

    • getConfig

      public arc.files.Fi getConfig(Mod mod)
      Returns:
      a file named 'config.json' in the config folder for the specified mod. Call this in init().

    • listFiles

      public void listFiles(String directory, arc.func.Cons2<Mods.LoadedMod,arc.files.Fi> cons)
      Returns a list of files per mod subdirectory.

    • getMod

      @Nullable public Mods.LoadedMod getMod(String name)
      Returns:
      the loaded mod found by name, or null if not found.

    • getMod

      @Nullable public Mods.LoadedMod getMod(Class<? extends Mod> type)
      Returns:
      the loaded mod found by class, or null if not found.

    • importMod

      public Mods.LoadedMod importMod(arc.files.Fi file) throws IOException
      Imports an external mod file. Folders are not supported here.
      Throws:
      IOException

    • loadAsync

      public void loadAsync()
      Repacks all in-game sprites.
      Specified by:
      loadAsync in interface arc.assets.Loadable

    • loadSync

      public void loadSync()
      Specified by:
      loadSync in interface arc.assets.Loadable

    • removeMod

      public void removeMod(Mods.LoadedMod mod)
      Removes a mod file and marks it for requiring a restart.

    • getScripts

      public Scripts getScripts()

    • hasScripts

      public boolean hasScripts()
      Returns:
      whether the scripting engine has been initialized.

    • requiresReload

      public boolean requiresReload()

    • skipModLoading

      public boolean skipModLoading()
      Returns:
      whether to skip mod loading due to previous initialization failure.

    • load

      public void load()
      Loads all mods from the folder, but does not call any methods on them.

    • orderedMods

      public arc.struct.Seq<Mods.LoadedMod> orderedMods()
      Returns:
      mods ordered in the correct way needed for dependencies.

    • locateMod

      public Mods.LoadedMod locateMod(String name)

    • reload

      public void reload()

    • hasContentErrors

      public boolean hasContentErrors()

    • loadScripts

      public void loadScripts()
      This must be run on the main thread!

    • loadContent

      public void loadContent()
      Creates all the content found in mod files.

    • handleContentError

      public void handleContentError(Content content, Throwable error)

    • addParseListener

      public void addParseListener(ContentParser.ParseListener hook)
      Adds a listener for parsed JSON objects.

    • getModStrings

      public arc.struct.Seq<String> getModStrings()
      Returns:
      a list of mods and versions, in the format name:version.

    • setEnabled

      public void setEnabled(Mods.LoadedMod mod, boolean enabled)
      Makes a mod enabled or disabled. shifts it.

    • getIncompatibility

      public arc.struct.Seq<String> getIncompatibility(arc.struct.Seq<String> out)
      Returns:
      the mods that the client is missing. The inputted array is changed to contain the extra mods that the client has but the server doesn't.

    • list

      public arc.struct.Seq<Mods.LoadedMod> list()

    • eachClass

      public void eachClass(arc.func.Cons<Mod> cons)
      Iterates through each mod with a main class.

    • eachEnabled

      public void eachEnabled(arc.func.Cons<Mods.LoadedMod> cons)
      Iterates through each enabled mod.

    • contextRun

      public void contextRun(Mods.LoadedMod mod, Runnable run)

    • findMeta

      @Nullable public Mods.ModMeta findMeta(arc.files.Fi file)
      Tries to find the config file of a mod/plugin.

    • resolveDependencies

      public arc.struct.OrderedMap<String,Mods.ModState> resolveDependencies(arc.struct.Seq<Mods.ModMeta> metas)
      Resolves the loading order of a list mods/plugins using their internal names.