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:

DelayedBase.IDelayedResolver<T>, org.gradle.api.Plugin<org.gradle.api.Project>

Direct Known Subclasses:

UserLibBasePlugin, UserPatchBasePlugin

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

Field Summary

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

assetIndex, otherPlugin, project, version

Constructor Summary

Constructors

Constructor and Description
UserBasePlugin()

Method Summary

Modifier and Type	Method and Description
void	afterEvaluate()
void	applyPlugin()
protected void	configureCompilation() This mod adds the API sourceSet, and correctly configures the
protected abstract void	configureDeobfuscation(ProcessJarTask task) Add Forge/FML ATs here.
protected void	configureDeps()
protected void	configureIntellij()
protected void	configurePostDecomp(boolean decomp, boolean remove) Configure tasks and stuff after you know if the decomp file exists or not.
protected DelayedFile	delayedDirtyFile(java.lang.String name, java.lang.String classifier, java.lang.String ext) Returns a file in the DirtyDir if the deobfuscation task is dirty.
protected DelayedFile	delayedDirtyFile(java.lang.String name, java.lang.String classifier, java.lang.String ext, boolean usesMappings) Returns a file in the DirtyDir if the deobfuscation task is dirty.
protected void	delayedTaskConfig() Allows for the configuration of tasks in AfterEvaluate
protected abstract void	doVersionChecks(java.lang.String version)
protected abstract java.lang.String	getApiCacheDir(T exten) May invoke the extension object, or be hardcoded.
abstract java.lang.String	getApiName() may not include delayed tokens.
protected abstract java.lang.String	getApiVersion(T exten) May invoke the extension object, or be hardcoded.
protected abstract java.lang.String	getBinDepName() Name of the source dependency.
protected abstract java.lang.Iterable<java.lang.String>	getClientRunArgs() For run configurations
protected abstract java.lang.String	getClientRunClass() For run configurations.
protected abstract java.lang.String	getClientTweaker() For run configurations.
protected java.lang.Class<T>	getExtensionClass() This extension object will have the name "minecraft"
protected abstract java.lang.String	getMcVersion(T exten) May invoke the extension object, or be hardcoded.
protected abstract java.lang.Iterable<java.lang.String>	getServerRunArgs() For run configurations
protected abstract java.lang.String	getServerRunClass() For run configurations.
protected abstract java.lang.String	getServerTweaker() For run configurations.
protected abstract java.lang.String	getSrcDepName() Name of the source dependency.
protected abstract java.lang.String	getSrgCacheDir(T exten) May invoke the extension object, or be hardcoded.
protected abstract java.lang.String	getStartDir() For run configurations
protected abstract java.lang.String	getUserDev() This unlike the others, is evaluated as a delayed string, and may contain various tokens including: {API_NAME} {API_VERSION} {MC_VERSION}
protected abstract java.lang.String	getUserDevCacheDir(T exten) May invoke the extension object, or be hardcoded.
protected abstract boolean	hasApiVersion() May invoke the extension object, or be hardcoded.
void	injectIntellijRuns(org.w3c.dom.Document doc, java.lang.String module)
java.lang.String	resolve(java.lang.String pattern, org.gradle.api.Project project, T exten)
protected void	setMinecraftDeps(boolean decomp, boolean remove)

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

addFlatRepo, addMavenRepo, apply, applyExternalPlugin, applyOverlayPlugin, canOverlayPlugin, delayedFile, delayedFileTree, delayedString, delayedZipTree, finalCall, getAssetIndex, getAssetIndexClosure, getDevJson, getExtension, getOverlayExtension, getProject, getWithEtag, makeTask, makeTask, makeTask, parseAssetIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

UserBasePlugin

public UserBasePlugin()

Method Detail

applyPlugin

public void applyPlugin()

Specified by:

applyPlugin in class BasePlugin<T extends UserExtension>

getApiName

public abstract java.lang.String getApiName()

may not include delayed tokens.

Returns:

name of API, eg "forge", "fml", "liteloader"

getSrcDepName

protected abstract java.lang.String getSrcDepName()

Name of the source dependency. eg: forgeSrc may not include delayed tokens.

Returns:

the name of the recompiled dependency

getBinDepName

protected abstract java.lang.String getBinDepName()

Name of the source dependency. eg: forgeBin may not include delayed tokens.

Returns:

the name of the bin-patched dependency

hasApiVersion

protected abstract boolean hasApiVersion()

May invoke the extension object, or be hardcoded. may not include delayed tokens.

Returns:

has an api version

getApiVersion

protected abstract java.lang.String getApiVersion(T exten)

May invoke the extension object, or be hardcoded. may not include delayed tokens.

Parameters:

exten - the extension object

Returns:

the api version

getMcVersion

protected abstract java.lang.String getMcVersion(T exten)

May invoke the extension object, or be hardcoded. may not include delayed tokens.

Parameters:

exten - the extension object

Returns:

the MC version

getApiCacheDir

protected abstract java.lang.String getApiCacheDir(T exten)

May invoke the extension object, or be hardcoded. This unlike the others, is evaluated as a delayed file, and may contain various tokens including: {API_NAME} {API_VERSION} {MC_VERSION}

Parameters:

exten - the extension object

Returns:

the API cache dir

getSrgCacheDir

protected abstract java.lang.String getSrgCacheDir(T exten)

May invoke the extension object, or be hardcoded. This unlike the others, is evaluated as a delayed file, and may contain various tokens including: {API_NAME} {API_VERSION} {MC_VERSION}

Parameters:

exten - the extension object

Returns:

the SRG cache dir

getUserDevCacheDir

protected abstract java.lang.String getUserDevCacheDir(T exten)

May invoke the extension object, or be hardcoded. This unlike the others, is evaluated as a delayed file, and may contain various tokens including: {API_NAME} {API_VERSION} {MC_VERSION}

Parameters:

exten - the extension object

Returns:

the userdev cache dir

getUserDev

protected abstract java.lang.String getUserDev()

This unlike the others, is evaluated as a delayed string, and may contain various tokens including: {API_NAME} {API_VERSION} {MC_VERSION}

Returns:

the userdev dep string

getClientTweaker

protected abstract java.lang.String getClientTweaker()

For run configurations. Is delayed.

Returns:

the client tweaker class name

getServerTweaker

protected abstract java.lang.String getServerTweaker()

For run configurations. Is delayed.

Returns:

the server tweaker class name

getStartDir

protected abstract java.lang.String getStartDir()

For run configurations

Returns:

the start location

getClientRunClass

protected abstract java.lang.String getClientRunClass()

For run configurations. Is delayed.

Returns:

the client main class name

getClientRunArgs

protected abstract java.lang.Iterable<java.lang.String> getClientRunArgs()

For run configurations

Returns:

the client run arguments

getServerRunClass

protected abstract java.lang.String getServerRunClass()

For run configurations. Is delayed.

Returns:

the server main class name

getServerRunArgs

protected abstract java.lang.Iterable<java.lang.String> getServerRunArgs()

For run configurations

Returns:

the server run arguments

resolve

public java.lang.String resolve(java.lang.String pattern,
                                org.gradle.api.Project project,
                                T exten)

Specified by:

resolve in interface DelayedBase.IDelayedResolver<T extends UserExtension>

Overrides:

resolve in class BasePlugin<T extends UserExtension>

configureDeps

protected void configureDeps()

configureCompilation

protected void configureCompilation()

This mod adds the API sourceSet, and correctly configures the

configureIntellij

protected void configureIntellij()

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

afterEvaluate

public final void afterEvaluate()

Overrides:

afterEvaluate in class BasePlugin<T extends UserExtension>

delayedTaskConfig

protected void delayedTaskConfig()

Allows for the configuration of tasks in AfterEvaluate

configurePostDecomp

protected void configurePostDecomp(boolean decomp,
                                   boolean remove)

Configure tasks and stuff after you know if the decomp file exists or not.

Parameters:

decomp - will decompile this task

remove - should remove old dependencies or not

setMinecraftDeps

protected void setMinecraftDeps(boolean decomp,
                                boolean remove)

configureDeobfuscation

protected abstract void configureDeobfuscation(ProcessJarTask task)

Add Forge/FML ATs here. This happens during normal evaluation, and NOT AfterEvaluate.

Parameters:

task - the deobfuscation task

doVersionChecks

protected abstract void doVersionChecks(java.lang.String version)

Parameters:

version - may have pre-release suffix _pre#

delayedDirtyFile

protected DelayedFile delayedDirtyFile(java.lang.String name,
                                       java.lang.String classifier,
                                       java.lang.String ext)

Returns a file in the DirtyDir if the deobfuscation task is dirty. Otherwise returns the cached one.

Parameters:

name - the name..

classifier - the classifier

ext - the extension

Returns:

delayed file

delayedDirtyFile

protected DelayedFile delayedDirtyFile(java.lang.String name,
                                       java.lang.String classifier,
                                       java.lang.String ext,
                                       boolean usesMappings)

Returns a file in the DirtyDir if the deobfuscation task is dirty. Otherwise returns the cached one.

Parameters:

name - the name..

classifier - the classifier

ext - the extension

usesMappings - whether or not MCP mappings are specified

Returns:

delayed file

getExtensionClass

protected java.lang.Class<T> getExtensionClass()

Description copied from class: BasePlugin

This extension object will have the name "minecraft"

Overrides:

getExtensionClass in class BasePlugin<T extends UserExtension>

Returns:

extension object class