Package net.fabricmc.loom.api

Interface LoomGradleExtensionAPI

All Known Subinterfaces:
LoomGradleExtension
All Known Implementing Classes:
LoomGradleExtensionApiImpl, LoomGradleExtensionImpl, MinecraftGradleExtension
public interface LoomGradleExtensionAPI
This is the public api available exposed to build scripts.

  • Method Details

    • getDeprecationHelper

      @Internal DeprecationHelper getDeprecationHelper()

    • getAccessWidenerPath

      org.gradle.api.file.RegularFileProperty getAccessWidenerPath()

    • getAccessWidener

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default File getAccessWidener()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setAccessWidener

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default void setAccessWidener​(File file)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getShareRemapCaches

      org.gradle.api.provider.Property<Boolean> getShareRemapCaches()

    • setShareCaches

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default void setShareCaches​(boolean shareCaches)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isShareCaches

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default boolean isShareCaches()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • shareCaches

      default void shareCaches()

    • getGameDecompilers

      org.gradle.api.provider.ListProperty<LoomDecompiler> getGameDecompilers()

    • getDecompilers

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default List<LoomDecompiler> getDecompilers()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addDecompiler

      default void addDecompiler​(LoomDecompiler decompiler)

    • getGameJarProcessors

      org.gradle.api.provider.ListProperty<JarProcessor> getGameJarProcessors()

    • getJarProcessors

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default List<JarProcessor> getJarProcessors()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addJarProcessor

      default void addJarProcessor​(JarProcessor processor)

    • getLog4jConfigs

      org.gradle.api.file.ConfigurableFileCollection getLog4jConfigs()

    • officialMojangMappings

      default org.gradle.api.artifacts.Dependency officialMojangMappings()

    • layered

      org.gradle.api.artifacts.Dependency layered​(org.gradle.api.Action<LayeredMappingSpecBuilder> action)

    • getRefmapName

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default String getRefmapName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setRefmapName

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default void setRefmapName​(String refmapName)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRemapArchives

      org.gradle.api.provider.Property<Boolean> getRemapArchives()

    • isRemapMod

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default boolean isRemapMod()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setRemapMod

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default void setRemapMod​(boolean remapMod)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • runs

      void runs​(org.gradle.api.Action<org.gradle.api.NamedDomainObjectContainer<RunConfigSettings>> action)

    • getRunConfigs

      org.gradle.api.NamedDomainObjectContainer<RunConfigSettings> getRunConfigs()

    • mixin

      void mixin​(org.gradle.api.Action<MixinExtensionAPI> action)

    • getMixin

      @Experimental MixinExtensionAPI getMixin()

    • getCustomMinecraftManifest

      org.gradle.api.provider.Property<String> getCustomMinecraftManifest()

    • setCustomManifest

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default void setCustomManifest​(String customManifest)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getCustomManifest

      @Deprecated(forRemoval=true) @ScheduledForRemoval(inVersion="0.11") default String getCustomManifest()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSetupRemappedVariants

      org.gradle.api.provider.Property<Boolean> getSetupRemappedVariants()
      If true, Loom will replace the -dev jars in the *Elements configurations with remapped outgoing variants.

      Will only apply if getRemapArchives() is also true.

      Returns:
      the property controlling the setup of remapped variants

    • disableDeprecatedPomGeneration

      @Experimental void disableDeprecatedPomGeneration​(org.gradle.api.publish.maven.MavenPublication publication)
      Disables the deprecated POM generation for a publication. This is useful if you want to suppress deprecation warnings when you're not using software components.

      Experimental API: Will be removed in Loom 0.12 together with the deprecated POM generation functionality.

      Parameters:
      publication - the maven publication

    • getModVersion

      String getModVersion()
      Reads the mod version from the fabric.mod.json file located in the main sourcesets resources. This is useful if you want to set the gradle version based of the version in the fabric.mod.json file.
      Returns:
      the version defined in the fabric.mod.json

    • getEnableTransitiveAccessWideners

      org.gradle.api.provider.Property<Boolean> getEnableTransitiveAccessWideners()
      When true loom will apply transitive access wideners from compile dependencies.
      Returns:
      the property controlling the transitive access wideners