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

Constructor Summary

Constructors

Constructor and Description
TweakerPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterEvaluate()
protected void	applyOverlayPlugin()
protected void	applyUserPlugin()
boolean	canOverlayPlugin() return true if this plugin can be applied over another BasePlugin.
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 TweakerExtension	getOverlayExtension()
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() To be inserted into GradleStart.
protected boolean	hasClientRun() This method is called early, and not late.
protected boolean	hasServerRun() This method is called early, and not late.

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

addAtsToDeobf, addEclipseRuns, applyPlugin, configureCompilation, configureIntellij, createSourceCopyTasks, injectIntellijRuns, mapConfigurations, tasksClient, tasksMerged, tasksServer, useLocalCache

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

addFlatRepo, addMavenRepo, apply, applyExternalPlugin, buildProject, cacheFile, delayedFile, delayedString, delayedTree, getExtension, getWithEtag, makeTask, makeTask, makeTask, maybeMakeTask, maybeMakeTask, maybeMakeTask, 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>

afterEvaluate

protected void afterEvaluate()

Overrides:

afterEvaluate in class UserBasePlugin<TweakerExtension>

getStartDir

protected java.lang.Object getStartDir()

Description copied from class: UserBasePlugin

To be inserted into GradleStart. This method is called early, and not late.

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.

hasServerRun

protected final boolean hasServerRun()

Description copied from class: UserBasePlugin

This method is called early, and not late.

Specified by:

hasServerRun in class UserBasePlugin<TweakerExtension>

Returns:

TRUE if a server run config and GradleStartServer should be created.

hasClientRun

protected final boolean hasClientRun()

Description copied from class: UserBasePlugin

This method is called early, and not late.

Specified by:

hasClientRun in class UserBasePlugin<TweakerExtension>

Returns:

TRUE if a client run config and GradleStart should be created.

applyOverlayPlugin

protected void applyOverlayPlugin()

Specified by:

applyOverlayPlugin in class BasePlugin<TweakerExtension>

canOverlayPlugin

public boolean canOverlayPlugin()

Description copied from class: BasePlugin

return true if this plugin can be applied over another BasePlugin.

Specified by:

canOverlayPlugin in class BasePlugin<TweakerExtension>

Returns:

TRUE if this can be applied upon another base plugin.

getOverlayExtension

protected TweakerExtension getOverlayExtension()

Specified by:

getOverlayExtension in class BasePlugin<TweakerExtension>

Returns:

the extension object with name EXT_NAME_MC

See Also:

Constants.EXT_NAME_MC