Package org.spongepowered.gradle.vanilla.runs

Class RunConfiguration

  • All Implemented Interfaces:
    org.gradle.api.Named
    public class RunConfiguration
extends java.lang.Object
implements org.gradle.api.Named
    A configuration for executing a Minecraft environment.

    • Nested Class Summary

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

        org.gradle.api.Named.Namer

    • Constructor Summary

      Constructors 
      Constructor Description
      RunConfiguration​(java.lang.String name, org.gradle.api.file.ProjectLayout layout, org.gradle.api.model.ObjectFactory objects, org.gradle.api.Project project)  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> allArguments()  
      java.util.List<java.lang.String> allJvmArguments()  
      void args​(java.lang.String... args)  
      void displayName​(java.lang.String displyName)  
      void environment​(java.lang.String name, java.lang.Object value)
      Adds an environment variable to the environment for this process.
      void environment​(java.util.Map<java.lang.String,​?> environment)
      Adds some environment variables to the environment for this process.
      java.util.Map<java.lang.String,​java.lang.String> getActualEnvironment()  
      java.util.List<org.gradle.process.CommandLineArgumentProvider> getAllArgumentProviders()  
      java.util.List<org.gradle.process.CommandLineArgumentProvider> getAllJvmArgumentProviders()  
      org.gradle.api.file.ConfigurableFileCollection getClasspath()
      Get the classpath used to run this game.
      org.gradle.api.provider.Property<java.lang.String> getDisplayName()  
      java.util.Map<java.lang.String,​java.lang.Object> getEnvironment()
      The environment variables to use for the process.
      org.gradle.api.provider.Property<org.gradle.api.tasks.SourceSet> getIdeaRunSourceSet()
      Deprecated.
      Use getSourceSet() instead.
      org.gradle.api.provider.Property<java.lang.String> getMainClass()  
      org.gradle.api.provider.Property<java.lang.String> getMainModule()  
      @NonNull java.lang.String getName()  
      org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.String> getParameterTokens()
      Get the run parameter tokens.
      org.gradle.api.provider.Property<java.lang.Boolean> getRequiresAssetsAndNatives()
      If assets and natives are required, this will make this run configuration depend on the assets and natives collection tasks.
      org.gradle.api.provider.Property<org.gradle.api.tasks.SourceSet> getSourceSet()
      Get the source set to use in the classpath and IDE runs.
      org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLanguageVersion> getTargetVersion()  
      org.gradle.api.file.DirectoryProperty getWorkingDirectory()  
      void jvmArgs​(java.lang.String... args)  
      void mainClass​(java.lang.String mainClass)  
      void mainModule​(java.lang.String mainModule)  
      void parameterTokens​(org.gradle.api.Action<org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.String>> action)
      Operate on the run parameter tokens.
      void setEnvironment​(java.util.Map<java.lang.String,​?> environment)
      Sets the environment variable to use for the process.
      void targetVersion​(int version)  
      void targetVersion​(org.gradle.jvm.toolchain.JavaLanguageVersion version)  
      void workingDirectory​(java.io.File directory)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RunConfiguration

        @Inject
public RunConfiguration​(java.lang.String name,
                        org.gradle.api.file.ProjectLayout layout,
                        org.gradle.api.model.ObjectFactory objects,
                        org.gradle.api.Project project)

    • Method Detail

      • getDisplayName

        @Input
@Optional
public org.gradle.api.provider.Property<java.lang.String> getDisplayName()

      • displayName

        public void displayName​(java.lang.String displyName)

      • getParameterTokens

        public org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.String> getParameterTokens()
        Get the run parameter tokens.

        These tokens are used to substitute values in arguments provided from a Mojang launcher manifest.

        Returns:
        a map of launcher meta tokens
        See Also:
        for known token names

      • parameterTokens

        public void parameterTokens​(org.gradle.api.Action<org.gradle.api.provider.MapProperty<java.lang.String,​java.lang.String>> action)
        Operate on the run parameter tokens.
        Parameters:
        action - an action to apply to the parameter tokens map
        See Also:
        for an explanation of what parameter tokens are

      • getRequiresAssetsAndNatives

        @Input
public org.gradle.api.provider.Property<java.lang.Boolean> getRequiresAssetsAndNatives()
        If assets and natives are required, this will make this run configuration depend on the assets and natives collection tasks.
        Returns:
        the assets and natives property

      • getActualEnvironment

        public java.util.Map<java.lang.String,​java.lang.String> getActualEnvironment()

      • getEnvironment

        @Internal
public java.util.Map<java.lang.String,​java.lang.Object> getEnvironment()
        The environment variables to use for the process.
        Returns:
        The environment.

      • setEnvironment

        public void setEnvironment​(java.util.Map<java.lang.String,​?> environment)
        Sets the environment variable to use for the process.
        Parameters:
        environment - The environment variables.

      • environment

        public void environment​(java.lang.String name,
                        java.lang.Object value)
        Adds an environment variable to the environment for this process.
        Parameters:
        name - The name of the variable.
        value - The value for the variable.

      • environment

        public void environment​(java.util.Map<java.lang.String,​?> environment)
        Adds some environment variables to the environment for this process.
        Parameters:
        environment - The environment variables.

      • getClasspath

        @Internal
public org.gradle.api.file.ConfigurableFileCollection getClasspath()
        Get the classpath used to run this game.
        Returns:
        the JVM classpath

      • getIdeaRunSourceSet

        @Deprecated
@Input
@Optional
public org.gradle.api.provider.Property<org.gradle.api.tasks.SourceSet> getIdeaRunSourceSet()
        Deprecated.
        Use getSourceSet() instead.
        Get the source set to be used when generating IDEA runs.
        Returns:
        the source set to use
        Since:
        0.2

      • getSourceSet

        @Input
public org.gradle.api.provider.Property<org.gradle.api.tasks.SourceSet> getSourceSet()
        Get the source set to use in the classpath and IDE runs.
        Returns:
        the source set to use
        Since:
        0.2.1

      • getAllArgumentProviders

        public java.util.List<org.gradle.process.CommandLineArgumentProvider> getAllArgumentProviders()

      • args

        public void args​(java.lang.String... args)

      • allArguments

        public java.util.List<java.lang.String> allArguments()

      • getAllJvmArgumentProviders

        public java.util.List<org.gradle.process.CommandLineArgumentProvider> getAllJvmArgumentProviders()

      • jvmArgs

        public void jvmArgs​(java.lang.String... args)

      • allJvmArguments

        public java.util.List<java.lang.String> allJvmArguments()

      • getWorkingDirectory

        @Internal
public org.gradle.api.file.DirectoryProperty getWorkingDirectory()

      • workingDirectory

        public void workingDirectory​(java.io.File directory)

      • getMainClass

        @Input
public org.gradle.api.provider.Property<java.lang.String> getMainClass()

      • mainClass

        public void mainClass​(java.lang.String mainClass)

      • getMainModule

        @Input
@Optional
public org.gradle.api.provider.Property<java.lang.String> getMainModule()

      • mainModule

        public void mainModule​(java.lang.String mainModule)

      • getTargetVersion

        @Input
public org.gradle.api.provider.Property<org.gradle.jvm.toolchain.JavaLanguageVersion> getTargetVersion()

      • targetVersion

        public void targetVersion​(org.gradle.jvm.toolchain.JavaLanguageVersion version)

      • targetVersion

        public void targetVersion​(int version)

      • getName

        @Input
public @NonNull java.lang.String getName()
        Specified by:
        getName in interface org.gradle.api.Named