Class SlimeLauncherOptionsImpl

java.lang.Object

net.minecraftforge.forgedev.tasks.launcher.SlimeLauncherOptionsImpl

All Implemented Interfaces:

SlimeLauncherOptions, SlimeLauncherOptionsInternal, SlimeLauncherOptionsNested, org.gradle.api.Named, org.gradle.api.reflect.HasPublicType

public abstract class SlimeLauncherOptionsImpl
extends Object
implements SlimeLauncherOptionsInternal

Nested Class Summary

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

org.gradle.api.Named.Namer

Field Summary

Fields inherited from interface net.minecraftforge.forgedev.tasks.launcher.SlimeLauncherOptionsInternal

LOGGER

Constructor Summary

Constructors

Constructor	Description
SlimeLauncherOptionsImpl(String name)

Method Summary

Modifier and Type	Method	Description
void	args(Iterable<?> args)	Adds to the arguments to pass to the main class.
void	args(Object args)	Adds to the arguments to pass to the main class.
void	args(Object... args)	Adds to the arguments to pass to the main class.
void	args(org.gradle.api.provider.Provider<? extends Iterable<?>> args)	Adds to the arguments to pass to the main class.
void	environment(String name, Object value)	Adds a single environment variable to use.
void	environment(Map<String,?> environment)	Adds to the environment variables to use.
void	environment(org.gradle.api.provider.Provider<? extends Map<String,?>> properties)	Adds to the environment variables to use.
org.gradle.api.provider.ListProperty<String>	getArgs()	The arguments to pass to the main class.
org.gradle.api.file.ConfigurableFileCollection	getClasspath()	The classpath to use.
org.gradle.api.provider.Property<Boolean>	getClient()
org.gradle.api.provider.MapProperty<String,String>	getEnvironment()	The environment variables to use.
org.gradle.api.provider.ListProperty<String>	getJvmArgs()	The JVM arguments to use.
org.gradle.api.provider.Property<String>	getMainClass()	The main class for Slime Launcher to use.
org.gradle.api.provider.Property<String>	getMaxHeapSize()	The maximum memory heap size to use.
org.gradle.api.provider.Property<String>	getMinHeapSize()	The minimum memory heap size to use.
String	getName()
org.gradle.api.provider.MapProperty<String, SlimeLauncherOptionsNested>	getNested()
protected abstract org.gradle.api.model.ObjectFactory	getObjects()
protected abstract org.gradle.api.provider.ProviderFactory	getProviders()
org.gradle.api.provider.MapProperty<String,String>	getSystemProperties()	The system properties to use.
org.gradle.api.file.DirectoryProperty	getWorkingDir()	The working directory to use.
SlimeLauncherOptionsInternal	inherit(Map<String, net.minecraftforge.util.data.json.RunConfig> configs, String sourceSetName, String name)
void	jvmArgs(Iterable<?> jvmArgs)	Adds to the JVM arguments to use.
void	jvmArgs(Object jvmArgs)	Adds to the JVM arguments to use.
void	jvmArgs(Object... jvmArgs)	Adds to the JVM arguments to use.
void	jvmArgs(org.gradle.api.provider.Provider<? extends Iterable<?>> jvmArgs)	Adds to the JVM arguments to use.
void	setArgs(String... args)	Sets the arguments to pass to the main class.
void	setJvmArgs(Object... jvmArgs)	Sets the JVM arguments to use.
void	systemProperties(Map<String,?> properties)	Adds to the system properties to use.
void	systemProperties(org.gradle.api.provider.Provider<? extends Map<String,?>> properties)	Adds to the system properties to use.
void	systemProperty(String name, Object value)	Adds a single system property to use.
String	toString()
void	with(String sourceSetName, org.gradle.api.Action<? super SlimeLauncherOptionsNested> action)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraftforge.forgedev.tasks.launcher.SlimeLauncherOptions

classpath, classpath, classpath, setClasspath, setClasspath, setClasspath, with

Methods inherited from interface net.minecraftforge.forgedev.tasks.launcher.SlimeLauncherOptionsInternal

getPublicType, inherit

Constructor Details

SlimeLauncherOptionsImpl

@Inject
public SlimeLauncherOptionsImpl(String name)

Method Details

getObjects

@Inject
protected abstract org.gradle.api.model.ObjectFactory getObjects()

getProviders

@Inject
protected abstract org.gradle.api.provider.ProviderFactory getProviders()

getName

public String getName()

Specified by:

getName in interface org.gradle.api.Named

Specified by:

getName in interface SlimeLauncherOptions

getMainClass

public org.gradle.api.provider.Property<String> getMainClass()

Description copied from interface: SlimeLauncherOptionsNested

The main class for Slime Launcher to use.

This is the class that will be invoked by Slime Launcher, not the main class of the JavaExec task that will be produced from these options.

Specified by:

getMainClass in interface SlimeLauncherOptionsNested

Returns:

A property for the main class

getArgs

public org.gradle.api.provider.ListProperty<String> getArgs()

Description copied from interface: SlimeLauncherOptionsNested

The arguments to pass to the main class.

This is the arguments that will be passed to the main class through Slime Launcher, not the arguments for Slime Launcher itself.

Specified by:

getArgs in interface SlimeLauncherOptionsNested

Returns:

A property for the arguments to pass to the main class

getJvmArgs

public org.gradle.api.provider.ListProperty<String> getJvmArgs()

Description copied from interface: SlimeLauncherOptionsNested

The JVM arguments to use.

These are applied immediately when Slime Launcher is executed. A reminder that Slime Launcher is not a re-launcher but a dev-environment bootstrapper.

Specified by:

getJvmArgs in interface SlimeLauncherOptionsNested

Returns:

A property for the JVM arguments

getClasspath

public org.gradle.api.file.ConfigurableFileCollection getClasspath()

Description copied from interface: SlimeLauncherOptions

The classpath to use.

The classpath in question must include Slime Launcher in it. By default, the forgedev extension adds Slime Launcher as a dependency to the consuming project's runtimeClasspath configuration.

Keep in mind that if the JavaExec task is configured to have a different main class, the classpath does not need to include Slime Launcher.

Specified by:

getClasspath in interface SlimeLauncherOptions

Returns:

The classpath to use

getMinHeapSize

public org.gradle.api.provider.Property<String> getMinHeapSize()

Description copied from interface: SlimeLauncherOptionsNested

The minimum memory heap size to use.

Working with this property is preferred over manually using the -Xms argument in the JVM arguments.

Specified by:

getMinHeapSize in interface SlimeLauncherOptionsNested

Returns:

A property for the minimum heap size

getMaxHeapSize

public org.gradle.api.provider.Property<String> getMaxHeapSize()

Description copied from interface: SlimeLauncherOptionsNested

The maximum memory heap size to use.

Working with this property is preferred over manually using the -Xmx argument in the JVM arguments.

Specified by:

getMaxHeapSize in interface SlimeLauncherOptionsNested

Returns:

A property for the maximum heap size

getSystemProperties

public org.gradle.api.provider.MapProperty<String,String> getSystemProperties()

Description copied from interface: SlimeLauncherOptionsNested

The system properties to use.

Specified by:

getSystemProperties in interface SlimeLauncherOptionsNested

Returns:

A property for the system properties

getEnvironment

public org.gradle.api.provider.MapProperty<String,String> getEnvironment()

Description copied from interface: SlimeLauncherOptionsNested

The environment variables to use.

Specified by:

getEnvironment in interface SlimeLauncherOptionsNested

Returns:

A property for the environment variables

getWorkingDir

public org.gradle.api.file.DirectoryProperty getWorkingDir()

Description copied from interface: SlimeLauncherOptions

The working directory to use.

By default, this will be run/name.

To clarify: this is the working directory of the Java process. Slime Launcher uses absolute file locations to place its caches and metadata, which do not interfere with the working directory.

Specified by:

getWorkingDir in interface SlimeLauncherOptions

Specified by:

getWorkingDir in interface SlimeLauncherOptionsNested

Returns:

A property for the working directory

getClient

public org.gradle.api.provider.Property<Boolean> getClient()

Specified by:

getClient in interface SlimeLauncherOptionsInternal

getNested

public org.gradle.api.provider.MapProperty<String, SlimeLauncherOptionsNested> getNested()

Specified by:

getNested in interface SlimeLauncherOptionsInternal

with

public void with(String sourceSetName,
 org.gradle.api.Action<? super SlimeLauncherOptionsNested> action)

Specified by:

with in interface SlimeLauncherOptions

args

public void args(Object args)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the arguments to pass to the main class.

Specified by:

args in interface SlimeLauncherOptionsNested

Parameters:

args - The arguments to add

See Also:

• SlimeLauncherOptionsNested.getArgs()

args

public void args(Object... args)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the arguments to pass to the main class.

Specified by:

args in interface SlimeLauncherOptionsNested

Parameters:

args - The arguments to add

See Also:

• SlimeLauncherOptionsNested.getArgs()

args

public void args(Iterable<?> args)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the arguments to pass to the main class.

Specified by:

args in interface SlimeLauncherOptionsNested

Parameters:

args - The arguments to add

See Also:

• SlimeLauncherOptionsNested.getArgs()

args

public void args(org.gradle.api.provider.Provider<? extends Iterable<?>> args)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the arguments to pass to the main class.

Specified by:

args in interface SlimeLauncherOptionsNested

Parameters:

args - The arguments to add

See Also:

• SlimeLauncherOptionsNested.getArgs()

setArgs

public void setArgs(String... args)

Description copied from interface: SlimeLauncherOptionsNested

Sets the arguments to pass to the main class.

Specified by:

setArgs in interface SlimeLauncherOptionsNested

Parameters:

args - The arguments

See Also:

• SlimeLauncherOptionsNested.getArgs()

jvmArgs

public void jvmArgs(Object jvmArgs)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the JVM arguments to use.

Specified by:

jvmArgs in interface SlimeLauncherOptionsNested

Parameters:

jvmArgs - The JVM argument to add

See Also:

• SlimeLauncherOptionsNested.getJvmArgs()

jvmArgs

public void jvmArgs(Object... jvmArgs)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the JVM arguments to use.

Specified by:

jvmArgs in interface SlimeLauncherOptionsNested

Parameters:

jvmArgs - The JVM arguments to add

See Also:

• SlimeLauncherOptionsNested.getJvmArgs()

jvmArgs

public void jvmArgs(Iterable<?> jvmArgs)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the JVM arguments to use.

Specified by:

jvmArgs in interface SlimeLauncherOptionsNested

Parameters:

jvmArgs - The JVM arguments to add

See Also:

• SlimeLauncherOptionsNested.getJvmArgs()

jvmArgs

public void jvmArgs(org.gradle.api.provider.Provider<? extends Iterable<?>> jvmArgs)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the JVM arguments to use.

Specified by:

jvmArgs in interface SlimeLauncherOptionsNested

Parameters:

jvmArgs - The JVM arguments to add

See Also:

• SlimeLauncherOptionsNested.getJvmArgs()

setJvmArgs

public void setJvmArgs(Object... jvmArgs)

Description copied from interface: SlimeLauncherOptionsNested

Sets the JVM arguments to use.

Specified by:

setJvmArgs in interface SlimeLauncherOptionsNested

Parameters:

jvmArgs - The arguments

See Also:

• HasMultipleValues.set(Iterable)

systemProperty

public void systemProperty(String name,
 Object value)

Description copied from interface: SlimeLauncherOptionsNested

Adds a single system property to use.

Specified by:

systemProperty in interface SlimeLauncherOptionsNested

Parameters:

name - The name

value - The value

See Also:

• SlimeLauncherOptionsNested.getSystemProperties()

systemProperties

public void systemProperties(Map<String,?> properties)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the system properties to use.

Specified by:

systemProperties in interface SlimeLauncherOptionsNested

Parameters:

properties - The system properties

See Also:

• SlimeLauncherOptionsNested.getSystemProperties()

systemProperties

public void systemProperties(org.gradle.api.provider.Provider<? extends Map<String,?>> properties)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the system properties to use.

Specified by:

systemProperties in interface SlimeLauncherOptionsNested

Parameters:

properties - The system properties

See Also:

• SlimeLauncherOptionsNested.getSystemProperties()

environment

public void environment(String name,
 Object value)

Description copied from interface: SlimeLauncherOptionsNested

Adds a single environment variable to use.

Specified by:

environment in interface SlimeLauncherOptionsNested

Parameters:

name - The name

value - The value

See Also:

• SlimeLauncherOptionsNested.getEnvironment()

environment

public void environment(Map<String,?> environment)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the environment variables to use.

Specified by:

environment in interface SlimeLauncherOptionsNested

Parameters:

environment - The environment variables

See Also:

• SlimeLauncherOptionsNested.getEnvironment()

environment

public void environment(org.gradle.api.provider.Provider<? extends Map<String,?>> properties)

Description copied from interface: SlimeLauncherOptionsNested

Adds to the environment variables to use.

Specified by:

environment in interface SlimeLauncherOptionsNested

Parameters:

properties - The environment variables

See Also:

• SlimeLauncherOptionsNested.getEnvironment()

inherit

public SlimeLauncherOptionsInternal inherit(Map<String, net.minecraftforge.util.data.json.RunConfig> configs,
 String sourceSetName,
 String name)

Specified by:

inherit in interface SlimeLauncherOptionsInternal

toString

public String toString()

Overrides:

toString in class Object