Package net.neoforged.nfrtgradle

Class NeoFormRuntimeTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.neoforged.nfrtgradle.NeoFormRuntimeTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
Direct Known Subclasses:
CreateMinecraftArtifacts, DownloadAssets
public abstract class NeoFormRuntimeTask extends org.gradle.api.DefaultTask
Base task implementation for running the NFRT CLI, regardless of which sub-command is used.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Task

    org.gradle.api.Task.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    NeoFormRuntimeTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    addArtifactsToManifest(org.gradle.api.artifacts.Configuration configuration)
    Add all incoming dependencies in the given configuration to the artifact manifest passed to NFRT.
    protected abstract org.gradle.process.ExecOperations
    getExecOperations()
     
    protected abstract org.gradle.api.file.DirectoryProperty
    getHomeDirectory()
    Where NFRT stores its caches, artifacts, assets, etc.
    protected abstract org.gradle.api.provider.Property<String>
    getJavaExecutable()
    Path to the Java executable to launch NFRT with.
    protected abstract org.gradle.jvm.toolchain.JavaToolchainService
    getJavaToolchainService()
     
    abstract org.gradle.api.file.ConfigurableFileCollection
    getNeoFormRuntime()
    You must ensure that this file collection contains a single file corresponding to the executable NFRT jar-file.
    abstract org.gradle.api.provider.Property<Boolean>
    getVerbose()
    Enable verbose output for the NFRT engine.
    protected abstract org.gradle.api.file.DirectoryProperty
    getWorkDirectory()
    Where NFRT will store temporary working directories.
    final void
    run(List<String> args)
    Use this from your task subclass or custom task actions to run NFRT with the given arguments.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, getConvention, notCompatibleWithConfigurationCache

  • Constructor Details

    • NeoFormRuntimeTask

      public NeoFormRuntimeTask()

  • Method Details

    • getNeoFormRuntime

      @Classpath @InputFiles public abstract org.gradle.api.file.ConfigurableFileCollection getNeoFormRuntime()
      You must ensure that this file collection contains a single file corresponding to the executable NFRT jar-file.

    • getVerbose

      @Internal public abstract org.gradle.api.provider.Property<Boolean> getVerbose()
      Enable verbose output for the NFRT engine. Defaults to false.

    • getJavaExecutable

      @Input @Internal protected abstract org.gradle.api.provider.Property<String> getJavaExecutable()
      Path to the Java executable to launch NFRT with. This is by default set to a Java 21 launcher.

    • getJavaToolchainService

      @Inject @Internal protected abstract org.gradle.jvm.toolchain.JavaToolchainService getJavaToolchainService()

    • getExecOperations

      @Inject @Internal protected abstract org.gradle.process.ExecOperations getExecOperations()

    • getHomeDirectory

      @Internal @Internal protected abstract org.gradle.api.file.DirectoryProperty getHomeDirectory()
      Where NFRT stores its caches, artifacts, assets, etc. This defaults to a subdirectory in the cache folder found in the Gradle user home.

    • getWorkDirectory

      @Internal @Internal protected abstract org.gradle.api.file.DirectoryProperty getWorkDirectory()
      Where NFRT will store temporary working directories. This defaults to using build/tmp/neoformruntime.

    • run

      public final void run(List<String> args)
      Use this from your task subclass or custom task actions to run NFRT with the given arguments.

    • addArtifactsToManifest

      public final void addArtifactsToManifest(org.gradle.api.artifacts.Configuration configuration)
      Add all incoming dependencies in the given configuration to the artifact manifest passed to NFRT. This causes NFRT to use files from the configuration when trying to resolve the same dependency coordinate, instead of downloading them.