Package net.fabricmc.loom.configuration.ide

Class RunConfigSettings

java.lang.Object

net.fabricmc.loom.configuration.ide.RunConfigSettings

All Implemented Interfaces:

RunConfiguration, RunConfigurationInternal, org.gradle.api.Named

public abstract class RunConfigSettings
extends Object
implements org.gradle.api.Named, RunConfiguration, RunConfigurationInternal

Nested Class Summary

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

org.gradle.api.Named.Namer

Constructor Summary

Constructors

Constructor	Description
RunConfigSettings(org.gradle.api.Project project, String name)

Method Summary

Modifier and Type	Method	Description
void	client()	Configure run config with the default client options.
void	clientData()	Configure run config with the default data options.
void	data()	Configure run config with the default data options.
void	defaultMainClass(String cls)	Deprecated. Use getMainClass() instead.
void	environment(String environment)	Deprecated. Use getEnvironment() instead.
void	environmentVariable(String name, Object value)	Deprecated. Use RunConfiguration.getEnvironmentVars() instead.
void	forgeTemplate(String templateName)	Deprecated.
abstract org.gradle.api.provider.Property<Boolean>	getAppendProjectPathToDisplayName()	Whether to append the project path to the RunConfiguration.getDisplayName() when project isn't the root project.
String	getConfigName()	Deprecated. Use RunConfiguration.getDisplayName() instead.
String	getDefaultMainClass()	Deprecated. Use getMainClass() instead.
String	getEnvironment()	Deprecated. Use RunConfiguration.getRuntimeEnvironment() instead.
Map<String,Object>	getEnvironmentVariables()	Deprecated. Use RunConfiguration.getEnvironmentVars() instead.
abstract org.gradle.api.provider.Property<String>	getIdeConfigFolder()	Group this run config under the given folder.
abstract org.gradle.api.provider.Property<String>	getMainClass()	The main class of the run configuration.
String	getName()
List<String>	getProgramArgs()	Deprecated. Use getProgramArgs() instead.
org.gradle.api.Project	getProject()	Technically deprecated, but as it shadows the "project" property from the parent class, it reports as deprecated in IDEs, which is undesirable.
String	getRunDir()	Deprecated. Use RunConfiguration.getRunDirectory() instead.
org.gradle.api.tasks.SourceSet	getSource(org.gradle.api.Project proj)	Deprecated. Use RunConfiguration.getSourceSet() instead.
List<String>	getVmArgs()	Deprecated. Use RunConfiguration.getJvmArguments() instead.
void	ideConfigGenerated(boolean ideConfigGenerated)	Deprecated. Use RunConfiguration.getGenerateRunConfig() instead.
void	inherit(RunConfigSettings parent)
boolean	isIdeConfigGenerated()	Deprecated. Use RunConfiguration.getGenerateRunConfig() instead.
void	makeRunDir()	Deprecated. No replacement
void	name(String name)	Deprecated. Use RunConfiguration.getDisplayName() instead.
void	programArg(String arg)	Deprecated. Use getProgramArgs() instead.
void	programArgs(String... args)	Deprecated. Use getProgramArgs() instead.
void	programArgs(Collection<String> args)	Deprecated. Use getProgramArgs() instead.
void	properties(Map<String,String> props)	Deprecated. Use RunConfiguration.getSystemProperties() instead.
void	property(String name)	Deprecated. Use RunConfiguration.getSystemProperties() instead.
void	property(String name, String value)	Deprecated. Use RunConfiguration.getSystemProperties() instead.
void	runDir(String dir)	Deprecated. Use RunConfiguration.getRunDirectory() instead.
void	server()	Configure run config with the default server options.
void	serverData()	Configure run config with the default data options.
void	serverWithGui()	Removes the nogui argument for the server configuration.
void	setConfigName(String name)	Deprecated. Use RunConfiguration.getDisplayName() instead.
void	setDefaultMainClass(String defaultMainClass)	Deprecated. Use getMainClass() instead.
void	setEnvironment(String environment)	Deprecated. Use RunConfiguration.getRuntimeEnvironment() instead.
void	setIdeConfigGenerated(boolean ideConfigGenerated)	Deprecated. Use RunConfiguration.getGenerateRunConfig() instead.
void	setName(String name)	Deprecated. Use RunConfiguration.getDisplayName() instead.
void	setRunDir(String runDir)	Deprecated. Use RunConfiguration.getRunDirectory() instead.
void	setSource(Function<org.gradle.api.Project,org.gradle.api.tasks.SourceSet> sourceFn)	Deprecated. Use RunConfiguration.getSourceSet() instead.
void	setSource(org.gradle.api.tasks.SourceSet source)	Deprecated. Use RunConfiguration.getSourceSet() instead.
void	source(String source)	Deprecated. Use RunConfiguration.getSourceSet() instead.
void	source(org.gradle.api.tasks.SourceSet source)	Deprecated. Use RunConfiguration.getSourceSet() instead.
void	startFirstThread()	Deprecated. No replacement
void	vmArg(String arg)	Deprecated. Use RunConfiguration.getJvmArguments() instead.
void	vmArgs(String... args)	Deprecated. Use RunConfiguration.getJvmArguments() instead.
void	vmArgs(Collection<String> args)	Deprecated. Use RunConfiguration.getJvmArguments() instead.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.fabricmc.loom.api.RunConfiguration

getDevLaunchMainClass, getDisplayName, getEnvironmentVars, getForgeTemplate, getGenerateRunConfig, getJvmArguments, getMods, getPreferGradleTask, getProgramArguments, getRunDirectory, getRuntimeEnvironment, getSourceSet, getSystemProperties, inherit, mods

Methods inherited from interface net.fabricmc.loom.configuration.ide.RunConfigurationInternal

getIsFinalised

Constructor Details

RunConfigSettings

@Inject
public RunConfigSettings(org.gradle.api.Project project,
 String name)

Method Details

getName

public String getName()

Specified by:

getName in interface org.gradle.api.Named

getAppendProjectPathToDisplayName

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

Description copied from interface: RunConfiguration

Whether to append the project path to the RunConfiguration.getDisplayName() when project isn't the root project.

Warning: could produce ambiguous run config names if disabled, unless used carefully in conjunction with RunConfiguration.getDisplayName().

Specified by:

getAppendProjectPathToDisplayName in interface RunConfiguration

getMainClass

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

Description copied from interface: RunConfiguration

The main class of the run configuration.

Specified by:

getMainClass in interface RunConfiguration

client

public void client()

Description copied from interface: RunConfiguration

Configure run config with the default client options.

Specified by:

client in interface RunConfiguration

server

public void server()

Description copied from interface: RunConfiguration

Configure run config with the default server options.

Specified by:

server in interface RunConfiguration

data

public void data()

Description copied from interface: RunConfiguration

Configure run config with the default data options.

This method can only be used on Forge and NeoForge.

Specified by:

data in interface RunConfiguration

clientData

public void clientData()

Description copied from interface: RunConfiguration

Configure run config with the default data options.

This method can only be used on NeoForge.

Specified by:

clientData in interface RunConfiguration

serverData

public void serverData()

Description copied from interface: RunConfiguration

Configure run config with the default data options.

This method can only be used on NeoForge.

Specified by:

serverData in interface RunConfiguration

inherit

public void inherit(RunConfigSettings parent)

serverWithGui

public void serverWithGui()

Removes the nogui argument for the server configuration. By default nogui is specified, this is a convenient way to remove it if wanted.

getIdeConfigFolder

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

Description copied from interface: RunConfiguration

Group this run config under the given folder.

This is currently only supported on IntelliJ IDEA.

Specified by:

getIdeConfigFolder in interface RunConfiguration

Returns:

The property used to set the config folder.

getProject

public org.gradle.api.Project getProject()

Technically deprecated, but as it shadows the "project" property from the parent class, it reports as deprecated in IDEs, which is undesirable.

setName

@Deprecated
public void setName(String name)

Deprecated.

Use RunConfiguration.getDisplayName() instead.

getVmArgs

@Deprecated
public List<String> getVmArgs()

Deprecated.

Use RunConfiguration.getJvmArguments() instead.

getProgramArgs

@Deprecated
public List<String> getProgramArgs()

Deprecated.

Use getProgramArgs() instead.

getEnvironment

@Deprecated
public String getEnvironment()

Deprecated.

Use RunConfiguration.getRuntimeEnvironment() instead.

setEnvironment

@Deprecated
public void setEnvironment(String environment)

Deprecated.

Use RunConfiguration.getRuntimeEnvironment() instead.

getConfigName

@Deprecated
public String getConfigName()

Deprecated.

Use RunConfiguration.getDisplayName() instead.

setConfigName

@Deprecated
public void setConfigName(String name)

Deprecated.

Use RunConfiguration.getDisplayName() instead.

getDefaultMainClass

@Deprecated
public String getDefaultMainClass()

Deprecated.

Use getMainClass() instead.

setDefaultMainClass

@Deprecated
public void setDefaultMainClass(String defaultMainClass)

Deprecated.

Use getMainClass() instead.

getRunDir

@Deprecated
public String getRunDir()

Deprecated.

Use RunConfiguration.getRunDirectory() instead.

setRunDir

@Deprecated
public void setRunDir(String runDir)

Deprecated.

Use RunConfiguration.getRunDirectory() instead.

getSource

@Deprecated
public org.gradle.api.tasks.SourceSet getSource(org.gradle.api.Project proj)

Deprecated.

Use RunConfiguration.getSourceSet() instead.

setSource

@Deprecated
public void setSource(org.gradle.api.tasks.SourceSet source)

Deprecated.

Use RunConfiguration.getSourceSet() instead.

setSource

@Deprecated
public void setSource(Function<org.gradle.api.Project,org.gradle.api.tasks.SourceSet> sourceFn)

Deprecated.

Use RunConfiguration.getSourceSet() instead.

environment

@Deprecated
public void environment(String environment)

Deprecated.

Use getEnvironment() instead.

name

@Deprecated
public void name(String name)

Deprecated.

Use RunConfiguration.getDisplayName() instead.

defaultMainClass

@Deprecated
public void defaultMainClass(String cls)

Deprecated.

Use getMainClass() instead.

runDir

@Deprecated
public void runDir(String dir)

Deprecated.

Use RunConfiguration.getRunDirectory() instead.

vmArg

@Deprecated
public void vmArg(String arg)

Deprecated.

Use RunConfiguration.getJvmArguments() instead.

vmArgs

@Deprecated
public void vmArgs(String... args)

Deprecated.

Use RunConfiguration.getJvmArguments() instead.

vmArgs

@Deprecated
public void vmArgs(Collection<String> args)

Deprecated.

Use RunConfiguration.getJvmArguments() instead.

programArg

@Deprecated
public void programArg(String arg)

Deprecated.

Use getProgramArgs() instead.

programArgs

@Deprecated
public void programArgs(String... args)

Deprecated.

Use getProgramArgs() instead.

programArgs

@Deprecated
public void programArgs(Collection<String> args)

Deprecated.

Use getProgramArgs() instead.

source

@Deprecated
public void source(org.gradle.api.tasks.SourceSet source)

Deprecated.

Use RunConfiguration.getSourceSet() instead.

source

@Deprecated
public void source(String source)

Deprecated.

Use RunConfiguration.getSourceSet() instead.

ideConfigGenerated

@Deprecated
public void ideConfigGenerated(boolean ideConfigGenerated)

Deprecated.

Use RunConfiguration.getGenerateRunConfig() instead.

getEnvironmentVariables

@Deprecated
public Map<String,Object> getEnvironmentVariables()

Deprecated.

Use RunConfiguration.getEnvironmentVars() instead.

environmentVariable

@Deprecated
public void environmentVariable(String name,
 Object value)

Deprecated.

Use RunConfiguration.getEnvironmentVars() instead.

property

@Deprecated
public void property(String name,
 String value)

Deprecated.

Use RunConfiguration.getSystemProperties() instead.

property

@Deprecated
public void property(String name)

Deprecated.

Use RunConfiguration.getSystemProperties() instead.

properties

@Deprecated
public void properties(Map<String,String> props)

Deprecated.

Use RunConfiguration.getSystemProperties() instead.

startFirstThread

@Deprecated
public void startFirstThread()

Deprecated.

No replacement

makeRunDir

@Deprecated
public void makeRunDir()

Deprecated.

No replacement

isIdeConfigGenerated

@Deprecated
public boolean isIdeConfigGenerated()

Deprecated.

Use RunConfiguration.getGenerateRunConfig() instead.

setIdeConfigGenerated

@Deprecated
public void setIdeConfigGenerated(boolean ideConfigGenerated)

Deprecated.

Use RunConfiguration.getGenerateRunConfig() instead.

forgeTemplate

@Deprecated
public void forgeTemplate(String templateName)

Deprecated.

Applies a Forge run config template to these settings.

Calling this method resets the defaultMainClass of this run config. If you don't want to use Forge's default main class, you need to specify one manually afterwards.

Parameters:

templateName - the template name (usually one of server, client, data)

Since:

1.0