net.minecraftforge.gradle.user.tweakers

Class TweakerPlugin

java.lang.Object

net.minecraftforge.gradle.common.BasePlugin<T>

net.minecraftforge.gradle.user.UserBasePlugin<TweakerExtension>

net.minecraftforge.gradle.user.tweakers.TweakerPlugin

All Implemented Interfaces:

org.gradle.api.Plugin<org.gradle.api.Project>

Direct Known Subclasses:

ClientTweaker, ServerTweaker

public abstract class TweakerPlugin
extends UserBasePlugin<TweakerExtension>

Field Summary

Fields inherited from class net.minecraftforge.gradle.user.UserBasePlugin

useLocalCache

Fields inherited from class net.minecraftforge.gradle.common.BasePlugin

otherPlugin, project, replacer

Constructor Summary

Constructors

Constructor and Description
TweakerPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterDecomp(boolean isDecomp, boolean useLocalCache, java.lang.String mcConfig) This method should add the MC dependency to the supplied config, as well as do any extra configuration that requires the provided information.
protected void	afterEvaluate()
protected void	applyUserPlugin()
protected abstract void	createDecompTasks(java.lang.String globalPattern, java.lang.String localPattern) Correctly invoke the makeDecomptasks() method from the UserBasePlugin
protected java.util.List<java.lang.String>	getClientJvmArgs(TweakerExtension ext) For run configurations.
protected java.util.List<java.lang.String>	getClientRunArgs(TweakerExtension ext) For run configurations.
protected java.lang.String	getClientRunClass(TweakerExtension ext) To be inserted into GradleStart.
protected java.lang.String	getClientTweaker(TweakerExtension ext) To be inserted into GradleStart.
protected abstract java.lang.String	getJarName() The name of the cached artifacts.
protected java.util.List<java.lang.String>	getServerJvmArgs(TweakerExtension ext) For run configurations.
protected java.util.List<java.lang.String>	getServerRunArgs(TweakerExtension ext) For run configurations.
protected java.lang.String	getServerRunClass(TweakerExtension ext) To be inserted into GradleStartServer.
protected java.lang.String	getServerTweaker(TweakerExtension ext) To be inserted into GradleStartServer.
protected java.lang.Object	getStartDir() The location where the GradleStart files will be generated to.

Methods inherited from class net.minecraftforge.gradle.user.UserBasePlugin

addAtsToDeobf, applyPlugin, chooseDeobfOutput, configureCompilation, configureEclipse, configureIntellij, createSourceCopyTasks, doDepAtExtraction, doDevTimeDeobf, getDummyDep, hasClientRun, hasServerRun, injectIntellijRuns, makeDecompTasks, makeObfSource, makeRunTasks, mapConfigurations, setupReobf, useLocalCache

Methods inherited from class net.minecraftforge.gradle.common.BasePlugin

addFlatRepo, addMavenRepo, apply, applyExternalPlugin, buildProject, cacheFile, delayedFile, delayedString, delayedTree, doFGVersionCheck, getExtension, getWithEtag, makeTask, makeTask, makeTask, maybeMakeTask, maybeMakeTask, maybeMakeTask, onVersionCheck, parseAndStoreVersion, parseAndStoreVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

TweakerPlugin

public TweakerPlugin()

Method Detail

applyUserPlugin

protected void applyUserPlugin()

Specified by:

applyUserPlugin in class UserBasePlugin<TweakerExtension>

afterDecomp

protected void afterDecomp(boolean isDecomp,
               boolean useLocalCache,
               java.lang.String mcConfig)

Description copied from class: UserBasePlugin

This method should add the MC dependency to the supplied config, as well as do any extra configuration that requires the provided information.

Specified by:

afterDecomp in class UserBasePlugin<TweakerExtension>

Parameters:

isDecomp - Whether to use the recmpield MC artifact

useLocalCache - Whetehr or not ATs were applied to this artifact

mcConfig - Which gradle configuration to add the MC dep to

afterEvaluate

protected void afterEvaluate()

Overrides:

afterEvaluate in class UserBasePlugin<TweakerExtension>

createDecompTasks

protected abstract void createDecompTasks(java.lang.String globalPattern,
                     java.lang.String localPattern)

Correctly invoke the makeDecomptasks() method from the UserBasePlugin

Parameters:

globalPattern - pattern for convenience

localPattern - pattern for convenience

getJarName

protected abstract java.lang.String getJarName()

The name of the cached artifacts. The name o fthe API.. primary identifier.. thing.

Returns:

"Minecraft" or "Minecraft_server" or something.

getStartDir

protected java.lang.Object getStartDir()

Description copied from class: UserBasePlugin

The location where the GradleStart files will be generated to.

Specified by:

getStartDir in class UserBasePlugin<TweakerExtension>

Returns:

object that resolves to a file

getClientTweaker

protected java.lang.String getClientTweaker(TweakerExtension ext)

Description copied from class: UserBasePlugin

To be inserted into GradleStart. Is called late afterEvaluate or at runtime.

Specified by:

getClientTweaker in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty string if no tweaker. NEVER NULL.

getServerTweaker

protected java.lang.String getServerTweaker(TweakerExtension ext)

Description copied from class: UserBasePlugin

To be inserted into GradleStartServer. Is called late afterEvaluate or at runtime.

Specified by:

getServerTweaker in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty string if no tweaker. NEVER NULL.

getClientRunClass

protected java.lang.String getClientRunClass(TweakerExtension ext)

Description copied from class: UserBasePlugin

To be inserted into GradleStart. Is called late afterEvaluate or at runtime.

Specified by:

getClientRunClass in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty string if default launchwrapper. NEVER NULL.

getClientRunArgs

protected java.util.List<java.lang.String> getClientRunArgs(TweakerExtension ext)

Description copied from class: UserBasePlugin

For run configurations. Is called late afterEvaluate or at runtime.

Specified by:

getClientRunArgs in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

getServerRunClass

protected java.lang.String getServerRunClass(TweakerExtension ext)

Description copied from class: UserBasePlugin

To be inserted into GradleStartServer. Is called late afterEvaluate or at runtime.

Specified by:

getServerRunClass in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty string if default launchwrapper. NEVER NULL.

getServerRunArgs

protected java.util.List<java.lang.String> getServerRunArgs(TweakerExtension ext)

Description copied from class: UserBasePlugin

For run configurations. Is called late afterEvaluate or at runtime.

Specified by:

getServerRunArgs in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

getClientJvmArgs

protected java.util.List<java.lang.String> getClientJvmArgs(TweakerExtension ext)

Description copied from class: UserBasePlugin

For run configurations. Is called late afterEvaluate or at runtime.

Specified by:

getClientJvmArgs in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

getServerJvmArgs

protected java.util.List<java.lang.String> getServerJvmArgs(TweakerExtension ext)

Description copied from class: UserBasePlugin

For run configurations. Is called late afterEvaluate or at runtime.

Specified by:

getServerJvmArgs in class UserBasePlugin<TweakerExtension>

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.