net.minecraftforge.gradle.user.lib

Class UserLibBasePlugin

java.lang.Object

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

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

net.minecraftforge.gradle.user.lib.UserLibBasePlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

LiteLoaderPlugin

public abstract class UserLibBasePlugin
extends UserBasePlugin<UserExtension>

Field Summary

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

assetIndex, otherPlugin, project, version

Constructor Summary

Constructors

Constructor and Description
UserLibBasePlugin()

Method Summary

Modifier and Type	Method and Description
void	applyPlugin()
protected void	configureDeobfuscation(ProcessJarTask task) Add Forge/FML ATs here.
protected void	doVersionChecks(java.lang.String version)
protected java.lang.String	getApiCacheDir(UserExtension exten) May invoke the extension object, or be hardcoded.
java.lang.String	getApiName() may not include delayed tokens.
protected java.lang.String	getApiVersion(UserExtension exten) May invoke the extension object, or be hardcoded.
protected java.lang.String	getBinDepName() Name of the source dependency.
protected DelayedFile	getDevJson()
protected java.lang.String	getMcVersion(UserExtension exten) May invoke the extension object, or be hardcoded.
UserExtension	getOverlayExtension()
protected java.lang.String	getSrcDepName() Name of the source dependency.
protected java.lang.String	getSrgCacheDir(UserExtension exten) May invoke the extension object, or be hardcoded.
protected java.lang.String	getStartDir() For run configurations
protected 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 java.lang.String	getUserDevCacheDir(UserExtension exten) May invoke the extension object, or be hardcoded.
protected boolean	hasApiVersion() May invoke the extension object, or be hardcoded.
java.lang.String	resolve(java.lang.String pattern, org.gradle.api.Project project, UserExtension exten)

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

afterEvaluate, configureCompilation, configureDeps, configureIntellij, configurePostDecomp, delayedDirtyFile, delayedDirtyFile, delayedTaskConfig, getClientRunArgs, getClientRunClass, getClientTweaker, getExtensionClass, getServerRunArgs, getServerRunClass, getServerTweaker, injectIntellijRuns, setMinecraftDeps

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

addFlatRepo, addMavenRepo, apply, applyExternalPlugin, applyOverlayPlugin, canOverlayPlugin, delayedFile, delayedFileTree, delayedString, delayedZipTree, finalCall, getAssetIndex, getAssetIndexClosure, getExtension, 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

UserLibBasePlugin

public UserLibBasePlugin()

Method Detail

applyPlugin

public void applyPlugin()

Overrides:

applyPlugin in class UserBasePlugin<UserExtension>

getStartDir

protected java.lang.String getStartDir()

Description copied from class: UserBasePlugin

For run configurations

Specified by:

getStartDir in class UserBasePlugin<UserExtension>

Returns:

the start location

getApiName

public java.lang.String getApiName()

Description copied from class: UserBasePlugin

may not include delayed tokens.

Specified by:

getApiName in class UserBasePlugin<UserExtension>

Returns:

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

getSrcDepName

protected java.lang.String getSrcDepName()

Description copied from class: UserBasePlugin

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

Specified by:

getSrcDepName in class UserBasePlugin<UserExtension>

Returns:

the name of the recompiled dependency

getBinDepName

protected java.lang.String getBinDepName()

Description copied from class: UserBasePlugin

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

Specified by:

getBinDepName in class UserBasePlugin<UserExtension>

Returns:

the name of the bin-patched dependency

hasApiVersion

protected boolean hasApiVersion()

Description copied from class: UserBasePlugin

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

Specified by:

hasApiVersion in class UserBasePlugin<UserExtension>

Returns:

has an api version

getApiVersion

protected java.lang.String getApiVersion(UserExtension exten)

Description copied from class: UserBasePlugin

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

Specified by:

getApiVersion in class UserBasePlugin<UserExtension>

Parameters:

exten - the extension object

Returns:

the api version

getMcVersion

protected java.lang.String getMcVersion(UserExtension exten)

Description copied from class: UserBasePlugin

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

Specified by:

getMcVersion in class UserBasePlugin<UserExtension>

Parameters:

exten - the extension object

Returns:

the MC version

getApiCacheDir

protected java.lang.String getApiCacheDir(UserExtension exten)

Description copied from class: UserBasePlugin

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}

Specified by:

getApiCacheDir in class UserBasePlugin<UserExtension>

Parameters:

exten - the extension object

Returns:

the API cache dir

getDevJson

protected DelayedFile getDevJson()

Specified by:

getDevJson in class BasePlugin<UserExtension>

getSrgCacheDir

protected java.lang.String getSrgCacheDir(UserExtension exten)

Description copied from class: UserBasePlugin

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}

Specified by:

getSrgCacheDir in class UserBasePlugin<UserExtension>

Parameters:

exten - the extension object

Returns:

the SRG cache dir

getUserDevCacheDir

protected java.lang.String getUserDevCacheDir(UserExtension exten)

Description copied from class: UserBasePlugin

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}

Specified by:

getUserDevCacheDir in class UserBasePlugin<UserExtension>

Parameters:

exten - the extension object

Returns:

the userdev cache dir

getUserDev

protected java.lang.String getUserDev()

Description copied from class: UserBasePlugin

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

Specified by:

getUserDev in class UserBasePlugin<UserExtension>

Returns:

the userdev dep string

configureDeobfuscation

protected final void configureDeobfuscation(ProcessJarTask task)

Description copied from class: UserBasePlugin

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

Specified by:

configureDeobfuscation in class UserBasePlugin<UserExtension>

Parameters:

task - the deobfuscation task

doVersionChecks

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

Specified by:

doVersionChecks in class UserBasePlugin<UserExtension>

Parameters:

version - may have pre-release suffix _pre#

getOverlayExtension

public UserExtension getOverlayExtension()

Specified by:

getOverlayExtension in class BasePlugin<UserExtension>

Returns:

the extension object with name EXT_NAME_MC

See Also:

Constants.EXT_NAME_MC

resolve

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

Specified by:

resolve in interface DelayedBase.IDelayedResolver<UserExtension>

Overrides:

resolve in class UserBasePlugin<UserExtension>