Package net.fabricmc.loom.task.prod

Class ClientProductionRunTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
net.fabricmc.loom.task.AbstractLoomTask
net.fabricmc.loom.task.prod.AbstractProductionRunTask
net.fabricmc.loom.task.prod.ClientProductionRunTask
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>
@Experimental @DisableCachingByDefault public abstract non-sealed class ClientProductionRunTask extends AbstractProductionRunTask
A task that runs the Minecraft client in a similar way to a production launcher. You must manually register a task of this type to use it.

  • Nested Class Summary

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

    org.gradle.api.Named.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
    ClientProductionRunTask()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    configureCommand(org.gradle.process.ExecSpec exec)
     
    protected void
    configureJvmArgs(org.gradle.process.ExecSpec exec)
     
    protected void
    configureProgramArgs(org.gradle.process.ExecSpec exec)
     
    protected abstract org.gradle.api.file.DirectoryProperty
    getAssetsDir()
     
    protected abstract org.gradle.api.provider.Property<String>
    getAssetsIndex()
     
    abstract org.gradle.api.provider.Property<TracyCapture>
    getTracyCapture()
     
    abstract org.gradle.api.provider.Property<Boolean>
    getUseXVFB()
    Whether to use XVFB to run the game, using a virtual framebuffer.
    void
    run()
     
    void
    tracy(org.gradle.api.Action<? super TracyCapture> action)
    Configures the tracy profiler to run alongside the game.

    Methods inherited from class net.fabricmc.loom.task.prod.AbstractProductionRunTask

    configureClasspath, configureMainClass, detachedConfigurationProvider, getClasspath, getExecOperations, getJavaLauncher, getJavaToolchainService, getJvmArgs, getMainClass, getMods, getProgramArgs, getProjectLoaderVersion, getRunDir, streamClasspath

    Methods inherited from class net.fabricmc.loom.task.AbstractLoomTask

    getExtension, getModPlatform

    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, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, 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, notCompatibleWithConfigurationCache

  • Constructor Details

    • ClientProductionRunTask

      @Inject public ClientProductionRunTask()

  • Method Details

    • getUseXVFB

      @Input public abstract org.gradle.api.provider.Property<Boolean> getUseXVFB()
      Whether to use XVFB to run the game, using a virtual framebuffer. This is useful for CI environments that don't have a display server.

      Defaults to true only on Linux and when the "CI" environment variable is set.

      XVFB must be installed, on Debian-based systems you can install it with: apt install -y xvfb

    • getTracyCapture

      @Optional public abstract org.gradle.api.provider.Property<TracyCapture> getTracyCapture()

    • tracy

      public void tracy(org.gradle.api.Action<? super TracyCapture> action)
      Configures the tracy profiler to run alongside the game. See @TracyCapture for more information.
      Parameters:
      action - The configuration action.

    • getAssetsIndex

      @Input protected abstract org.gradle.api.provider.Property<String> getAssetsIndex()

    • getAssetsDir

      @InputFiles @PathSensitive(ABSOLUTE) protected abstract org.gradle.api.file.DirectoryProperty getAssetsDir()

    • run

      public void run() throws IOException
      Overrides:
      run in class AbstractProductionRunTask
      Throws:
      IOException

    • configureCommand

      protected void configureCommand(org.gradle.process.ExecSpec exec)
      Overrides:
      configureCommand in class AbstractProductionRunTask

    • configureJvmArgs

      protected void configureJvmArgs(org.gradle.process.ExecSpec exec)
      Overrides:
      configureJvmArgs in class AbstractProductionRunTask

    • configureProgramArgs

      protected void configureProgramArgs(org.gradle.process.ExecSpec exec)
      Overrides:
      configureProgramArgs in class AbstractProductionRunTask