Interface MavenizerInstance

All Superinterfaces:
org.gradle.api.provider.ProviderConvertible<org.gradle.api.artifacts.ExternalModuleDependency>
public interface MavenizerInstance extends org.gradle.api.provider.ProviderConvertible<org.gradle.api.artifacts.ExternalModuleDependency>

A Mavenizer instance is an abstraction over an invocation of the Minecraft Mavenizer and its output when generating a Minecraft dependency. This is designed to be consumed by one of the various MinecraftExtensionForProject.dependency(Object, Closure) methods as it is a ProviderConvertible of a dependency.

This is not to be confused with MinecraftDependency, which is designed to add additional DSL features on top of ExternalModuleDependency when configuring a Minecraft dependency in your buildscript.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Provider<org.gradle.api.artifacts.ExternalModuleDependency>
    asProvider()
    Gets the dependency (used by Gradle) generated by the Mavenizer instance.
    org.gradle.api.provider.Provider<String>
    getMappingChannel()
    Gets the mappings channel used by the Mavenizer instance.
    org.gradle.api.provider.Provider<String>
    getMappingVersion()
    Gets the mappings version used by the Mavenizer instance.
    org.gradle.api.provider.Provider<String>
    getMCPVersion()
    Gets the MCP Config version used by the Mavenizer instance.
    org.gradle.api.provider.Provider<String>
    getMinecraftVersion()
    Gets the Minecraft Version used by the Mavenizer instance.
    org.gradle.api.provider.Provider<String>
    getToObf()
    Gets the artifact coordinates for the SRG mappings used by the Mavenizer instance.
    org.gradle.api.provider.Provider<File>
    getToObfFile()
    Gets the notch mapping file used by the Mavenizer instance.
    org.gradle.api.provider.Provider<String>
    getToSrg()
    Gets the artifact coordinates for the SRG mappings used by the Mavenizer instance.
    org.gradle.api.provider.Provider<File>
    getToSrgFile()
    Gets the SRG mapping file used by the Mavenizer instance.

  • Method Details

    • asProvider

      org.gradle.api.provider.Provider<org.gradle.api.artifacts.ExternalModuleDependency> asProvider()
      Gets the dependency (used by Gradle) generated by the Mavenizer instance.
      Specified by:
      asProvider in interface org.gradle.api.provider.ProviderConvertible<org.gradle.api.artifacts.ExternalModuleDependency>
      Returns:
      The dependency generated by this instance

    • getMappingChannel

      org.gradle.api.provider.Provider<String> getMappingChannel()
      Gets the mappings channel used by the Mavenizer instance.
      Returns:
      The mappings channel used, after all sanitization has been done, should match exactly to the generated maven artifact
      See Also:

    • getMappingVersion

      org.gradle.api.provider.Provider<String> getMappingVersion()
      Gets the mappings version used by the Mavenizer instance.
      Returns:
      The mappings version used, after all sanitization has been done, should match exactly to the generated maven artifact
      See Also:

    • getToSrg

      org.gradle.api.provider.Provider<String> getToSrg()
      Gets the artifact coordinates for the SRG mappings used by the Mavenizer instance.
      Returns:
      The SRG mapping artifact coordinate

    • getToSrgFile

      org.gradle.api.provider.Provider<File> getToSrgFile()
      Gets the SRG mapping file used by the Mavenizer instance.
      Returns:
      The SRG mapping file
      API Note:
      Buildscript authors should prefer to use getToSrg() with DependencyFactory.create(CharSequence) or DependencyHandler.addProvider(String, Provider).

    • getToObf

      org.gradle.api.provider.Provider<String> getToObf()
      Gets the artifact coordinates for the SRG mappings used by the Mavenizer instance.
      Returns:
      The SRG mapping artifact coordinate

    • getToObfFile

      org.gradle.api.provider.Provider<File> getToObfFile()
      Gets the notch mapping file used by the Mavenizer instance.
      Returns:
      The notch mapping file
      API Note:
      Buildscript authors should prefer to use getToObf() with DependencyFactory.create(CharSequence) or DependencyHandler.addProvider(String, Provider).

    • getMinecraftVersion

      org.gradle.api.provider.Provider<String> getMinecraftVersion()
      Gets the Minecraft Version used by the Mavenizer instance. Only returns a value when Mavenizer is above 0.4.33
      Returns:
      The Minecraft Version

    • getMCPVersion

      org.gradle.api.provider.Provider<String> getMCPVersion()
      Gets the MCP Config version used by the Mavenizer instance. Only returns a value when Mavenizer is above 0.4.33, and we're targeting an artifact that uses MCP Config. So Forge for Minecraft 1.13+
      Returns:
      The MCP Version