Package net.neoforged.nfrtgradle

Class NeoFormRuntimeExtension

java.lang.Object
net.neoforged.nfrtgradle.NeoFormRuntimeExtension
public abstract class NeoFormRuntimeExtension extends Object
Configures aspects of the NeoForm Runtime (NFRT), which is used by this plugin to produce the Minecraft artifacts for compiling and mods.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    NeoFormRuntimeExtension(org.gradle.api.Project project)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<Boolean>
    getAnalyzeCacheMisses()
    Enables additional logging in NFRT when an operation cannot reuse any of the previously cached intermediate results.
    abstract org.gradle.api.provider.Property<Boolean>
    getEnableCache()
    Controls whether NFRT uses its cache at all.
    abstract org.gradle.api.provider.Property<Boolean>
    getUseEclipseCompiler()
    Enable use of the Eclipse compiler to recompile the Minecraft assets.
    abstract org.gradle.api.provider.Property<Boolean>
    getVerbose()
    Enables verbose logging for NFRT tasks (such as createMinecraftArtifacts).
    abstract org.gradle.api.provider.Property<String>
    getVersion()
    Overrides the version of NFRT to use.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • NeoFormRuntimeExtension

      @Inject public NeoFormRuntimeExtension(org.gradle.api.Project project)

  • Method Details

    • getVersion

      public abstract org.gradle.api.provider.Property<String> getVersion()
      Overrides the version of NFRT to use. This is an advanced feature. This plugin will default to a compatible version.

      Gradle property: neoForge.neoFormRuntime.version.

    • getUseEclipseCompiler

      public abstract org.gradle.api.provider.Property<Boolean> getUseEclipseCompiler()
      Enable use of the Eclipse compiler to recompile the Minecraft assets.

      While producing generally similar results, the Eclipse compiler can use multiple cores during recompilation, speeding up the process if you have many CPU cores.

      Default: false
      Gradle property: neoForge.neoFormRuntime.useEclipseCompiler.

    • getEnableCache

      public abstract org.gradle.api.provider.Property<Boolean> getEnableCache()
      Controls whether NFRT uses its cache at all.

      Default: true
      Gradle property: neoForge.neoFormRuntime.enableCache.

    • getVerbose

      public abstract org.gradle.api.provider.Property<Boolean> getVerbose()
      Enables verbose logging for NFRT tasks (such as createMinecraftArtifacts).

      Default: false
      Gradle property: neoForge.neoFormRuntime.verbose.

    • getAnalyzeCacheMisses

      public abstract org.gradle.api.provider.Property<Boolean> getAnalyzeCacheMisses()
      Enables additional logging in NFRT when an operation cannot reuse any of the previously cached intermediate results. This has a performance impact, since it involves scanning the cache directory for similar results.

      Default: false
      Gradle property: neoForge.neoFormRuntime.analyzeCacheMisses.