net.minecraftforge.gradle.user

Class UserBasePlugin<T extends UserExtension>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TweakerPlugin

public abstract class UserBasePlugin<T extends UserExtension>
extends BasePlugin<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	useLocalCache A boolean used to cache the output of useLocalCache;

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

otherPlugin, project

Constructor Summary

Constructors

Constructor and Description
UserBasePlugin()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAtsToDeobf()
protected void	addEclipseRuns() Creates task that generate the eclipse run configs and attaches them to the eclipse task.
protected void	afterEvaluate()
void	applyPlugin()
protected abstract void	applyUserPlugin()
protected void	configureCompilation() Creates the api SourceSet and configures the classpaths of all the SourceSets to have MC and the MC deps in them.
protected void	configureIntellij() Adds the intellij run configs and makes a few other tweaks to the intellij project creation
protected void	createSourceCopyTasks() Creates and partially configures the source replacement tasks.
protected abstract java.util.List<java.lang.String>	getClientRunArgs(T ext) For run configurations.
protected abstract java.lang.String	getClientRunClass(T ext) To be inserted into GradleStart.
protected abstract java.lang.String	getClientTweaker(T ext) To be inserted into GradleStart.
protected abstract java.util.List<java.lang.String>	getServerRunArgs(T ext) For run configurations.
protected abstract java.lang.String	getServerRunClass(T ext) To be inserted into GradleStartServer.
protected abstract java.lang.String	getServerTweaker(T ext) To be inserted into GradleStartServer.
protected abstract java.lang.Object	getStartDir() To be inserted into GradleStart.
protected abstract boolean	hasClientRun() This method is called early, and not late.
protected abstract boolean	hasServerRun() This method is called early, and not late.
void	injectIntellijRuns(org.w3c.dom.Document doc, java.lang.String module)
protected void	mapConfigurations()
protected void	tasksClient(java.lang.String globalPattern, java.lang.String localPattern)
protected void	tasksMerged(java.lang.String globalPattern, java.lang.String localPattern)
protected void	tasksServer(java.lang.String globalPattern, java.lang.String localPattern)
protected boolean	useLocalCache(T extension) This method is called sufficiently late.

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

addFlatRepo, addMavenRepo, apply, applyExternalPlugin, applyOverlayPlugin, buildProject, cacheFile, canOverlayPlugin, delayedFile, delayedString, delayedTree, getExtension, getOverlayExtension, 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

Field Detail

useLocalCache

protected boolean useLocalCache

A boolean used to cache the output of useLocalCache;

See Also:

useLocalCache

Constructor Detail

UserBasePlugin

public UserBasePlugin()

Method Detail

applyPlugin

public final void applyPlugin()

Specified by:

applyPlugin in class BasePlugin<T extends UserExtension>

afterEvaluate

protected void afterEvaluate()

Overrides:

afterEvaluate in class BasePlugin<T extends UserExtension>

applyUserPlugin

protected abstract void applyUserPlugin()

tasksClient

protected void tasksClient(java.lang.String globalPattern,
               java.lang.String localPattern)

tasksServer

protected void tasksServer(java.lang.String globalPattern,
               java.lang.String localPattern)

tasksMerged

protected void tasksMerged(java.lang.String globalPattern,
               java.lang.String localPattern)

useLocalCache

protected boolean useLocalCache(T extension)

This method is called sufficiently late. Either afterEvaluate or inside a task, thus it has the extension object. This method is called to decide whether or not to use the project-local cache instead of the global cache. The actual locations of each cache are specified elsewhere. TODO: add see annotations

Parameters:

extension - The extension object of this plugin

Returns:

whether or not to use the local cache

configureCompilation

protected void configureCompilation()

Creates the api SourceSet and configures the classpaths of all the SourceSets to have MC and the MC deps in them. Also sets the target JDK to java 6

createSourceCopyTasks

protected void createSourceCopyTasks()

Creates and partially configures the source replacement tasks. The actual replacements must be configured afterEvaluate.

mapConfigurations

protected void mapConfigurations()

addAtsToDeobf

protected void addAtsToDeobf()

hasServerRun

protected abstract boolean hasServerRun()

This method is called early, and not late.

Returns:

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

hasClientRun

protected abstract boolean hasClientRun()

This method is called early, and not late.

Returns:

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

getStartDir

protected abstract java.lang.Object getStartDir()

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

Returns:

object that resolves to a file

getClientTweaker

protected abstract java.lang.String getClientTweaker(T ext)

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

Parameters:

ext - the Extension object

Returns:

empty string if no tweaker. NEVER NULL.

getServerTweaker

protected abstract java.lang.String getServerTweaker(T ext)

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

Parameters:

ext - the Extension object

Returns:

empty string if no tweaker. NEVER NULL.

getClientRunClass

protected abstract java.lang.String getClientRunClass(T ext)

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

Parameters:

ext - the Extension object

Returns:

empty string if default launchwrapper. NEVER NULL.

getClientRunArgs

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

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

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

getServerRunClass

protected abstract java.lang.String getServerRunClass(T ext)

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

Parameters:

ext - the Extension object

Returns:

empty string if default launchwrapper. NEVER NULL.

getServerRunArgs

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

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

Parameters:

ext - the Extension object

Returns:

empty list for no arguments. NEVER NULL.

addEclipseRuns

protected void addEclipseRuns()

Creates task that generate the eclipse run configs and attaches them to the eclipse task.

configureIntellij

protected void configureIntellij()

Adds the intellij run configs and makes a few other tweaks to the intellij project creation

injectIntellijRuns

public final void injectIntellijRuns(org.w3c.dom.Document doc,
                      java.lang.String module)
                              throws org.w3c.dom.DOMException,
                                     java.io.IOException

Throws:

org.w3c.dom.DOMException

java.io.IOException