Package dev.architectury.loom.metadata

Interface ModMetadataFile

All Known Subinterfaces:
JsonBackedModMetadataFile
All Known Implementing Classes:
ArchitecturyCommonJson, ErroringModMetadataFile, McmodInfo, ModsToml, QuiltModJson
public interface ModMetadataFile
The metadata file of a mod, such as architectury.common.json or quilt.mod.json.
See Also:

  • Method Details

    • getIds

      Set<String> getIds()
      Returns all mod IDs in this mod metadata file..
      Returns:
      all mod IDs in this mod metadata file

    • getId

      default @Nullable String getId()
      Returns the mod ID in this mod metadata file, or null if absent..
      Returns:
      the mod ID in this mod metadata file, or null if absent

    • getAccessWideners

      Set<String> getAccessWideners()
      Returns the paths to the access widener file of this mod, or an empty set if absent..
      Returns:
      the paths to the access widener file of this mod, or an empty set if absent

    • getAccessTransformers

      Set<String> getAccessTransformers(ModPlatform platform)
      Returns the paths to the access transformer files of this mod, or an empty set if absent..
      Parameters:
      platform - the platform to run the query on
      Returns:
      the paths to the access transformer files of this mod, or an empty set if absent

    • getInjectedInterfaces

      List<InterfaceInjectionProcessor.InjectedInterface> getInjectedInterfaces(@Nullable String modId)
      Returns the injected interface data in this mod metadata file..
      Parameters:
      modId - the mod ID to use as a fallback if getId() returns null
      Returns:
      the injected interface data in this mod metadata file
      Throws:
      IllegalArgumentException - if both modId and getId() are null

    • getFileName

      String getFileName()
      Returns the file name of this mod metadata file..
      Returns:
      the file name of this mod metadata file

    • getMixinConfigs

      List<String> getMixinConfigs()
      Returns a list of the mixin configs declared in this mod metadata file..
      Returns:
      a list of the mixin configs declared in this mod metadata file