Interface SlimeLauncherOptions

All Superinterfaces:

org.gradle.api.Named, SlimeLauncherOptionsNested

All Known Subinterfaces:

SlimeLauncherOptionsInternal

All Known Implementing Classes:

SlimeLauncherOptionsImpl

public interface SlimeLauncherOptions
extends SlimeLauncherOptionsNested, org.gradle.api.Named

Nested Class Summary

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

org.gradle.api.Named.Namer

Method Summary

Modifier and Type	Method	Description
default void	classpath(Iterable<?> classpath)	Adds to the classpath to use.
default void	classpath(Object... classpath)	Adds to the classpath to use.
default void	classpath(org.gradle.api.file.FileCollection classpath)	Adds to the classpath to use.
org.gradle.api.file.ConfigurableFileCollection	getClasspath()	The classpath to use.
String	getName()
org.gradle.api.file.DirectoryProperty	getWorkingDir()	The working directory to use.
default void	setClasspath(Iterable<?> classpath)	Sets the classpath to use.
default void	setClasspath(Object... classpath)	Sets the classpath to use.
default void	setClasspath(org.gradle.api.file.FileCollection classpath)	Sets the classpath to use.
void	with(String sourceSetName, org.gradle.api.Action<? super SlimeLauncherOptionsNested> action)
default void	with(org.gradle.api.tasks.SourceSet sourceSet, org.gradle.api.Action<? super SlimeLauncherOptionsNested> action)

Methods inherited from interface net.minecraftforge.gradle.SlimeLauncherOptionsNested

args, args, args, args, environment, environment, environment, getArgs, getEnvironment, getJvmArgs, getMainClass, getMaxHeapSize, getMinHeapSize, getSystemProperties, jvmArgs, jvmArgs, jvmArgs, jvmArgs, setArgs, setJvmArgs, systemProperties, systemProperties, systemProperty

Method Details

getName

@Input
String getName()

Specified by:

getName in interface org.gradle.api.Named

with

default void with(org.gradle.api.tasks.SourceSet sourceSet,
 org.gradle.api.Action<? super SlimeLauncherOptionsNested> action)

with

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

getClasspath

@InputFiles
@Classpath
@Optional
org.gradle.api.file.ConfigurableFileCollection getClasspath()

The classpath to use.

The classpath in question must include Slime Launcher in it. By default, Slime Launcher is added on top of the project's runtimeClasspath configuration for this task.

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.

Returns:

The classpath to use

getWorkingDir

@Internal
org.gradle.api.file.DirectoryProperty getWorkingDir()

The working directory to use.

By default, this will be run/sourceSet/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 SlimeLauncherOptionsNested

Returns:

A property for the working directory

classpath

default void classpath(Object... classpath)

Adds to the classpath to use.

Parameters:

classpath - The classpath to include with the existing classpath

See Also:

• getClasspath()

API Note:

Unlike setClasspath(Object...), this method does not replace the existing classpath.

classpath

default void classpath(Iterable<?> classpath)

Adds to the classpath to use.

Parameters:

classpath - The classpath to include with the existing classpath

See Also:

• getClasspath()

API Note:

Unlike setClasspath(Iterable), this method does not replace the existing classpath.

classpath

default void classpath(org.gradle.api.file.FileCollection classpath)

Adds to the classpath to use.

Parameters:

classpath - The classpath to include with the existing classpath

See Also:

• getClasspath()

API Note:

Unlike setClasspath(FileCollection), this method does not replace the existing classpath.

setClasspath

default void setClasspath(Object... classpath)

Sets the classpath to use.

Parameters:

classpath - The classpath

See Also:

• SlimeLauncherOptionsNested.getJvmArgs()

API Note:

This method will replace the existing classpath. To add to it, use classpath(Object...).

setClasspath

default void setClasspath(Iterable<?> classpath)

Sets the classpath to use.

Parameters:

classpath - The classpath

See Also:

• SlimeLauncherOptionsNested.getJvmArgs()

API Note:

This method will replace the existing classpath. To add to it, use classpath(Iterable).

setClasspath

default void setClasspath(org.gradle.api.file.FileCollection classpath)

Sets the classpath to use.

Parameters:

classpath - The classpath

See Also:

• SlimeLauncherOptionsNested.getJvmArgs()

API Note:

This method will replace the existing classpath. To add to it, use classpath(FileCollection).