net.minecraftforge.gradle.user.patch

Class UserPatchBasePlugin

java.lang.Object

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

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

net.minecraftforge.gradle.user.patch.UserPatchBasePlugin

All Implemented Interfaces:

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

Direct Known Subclasses:

FmlUserPlugin, ForgeUserPlugin

public abstract class UserPatchBasePlugin
extends UserBasePlugin<UserPatchExtension>

Field Summary

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

assetIndex, otherPlugin, project, version

Constructor Summary

Constructors

Constructor and Description
UserPatchBasePlugin()

Method Summary

Modifier and Type	Method and Description
void	applyOverlayPlugin()
void	applyPlugin()
boolean	canOverlayPlugin() return true if this plugin can be applied over another BasePlugin.
protected abstract void	configurePatching(ProcessSrcJarTask patch) Add in the desired patching stages.
protected void	configurePostDecomp(boolean decomp, boolean remove) Configure tasks and stuff after you know if the decomp file exists or not.
protected void	delayedTaskConfig() Allows for the configuration of tasks in AfterEvaluate
protected void	doVersionChecks(java.lang.String version)
protected abstract void	doVersionChecks(java.lang.String version, int buildNumber)
protected java.lang.String	getApiCacheDir(UserPatchExtension exten) May invoke the extension object, or be hardcoded.
protected abstract java.lang.String	getApiGroup() Should be with separate with periods.
protected java.lang.String	getApiPath(UserPatchExtension exten) Should be with separate with slashes.
protected java.lang.String	getApiVersion(UserPatchExtension exten) May invoke the extension object, or be hardcoded.
protected java.lang.String	getBinDepName() Name of the source dependency.
protected java.lang.Iterable<java.lang.String>	getClientRunArgs() For run configurations
protected java.lang.String	getClientRunClass() For run configurations.
protected java.lang.String	getClientTweaker() For run configurations.
protected DelayedFile	getDevJson()
protected java.lang.Class<UserPatchExtension>	getExtensionClass() This extension object will have the name "minecraft"
protected java.lang.String	getMcVersion(UserPatchExtension exten) May invoke the extension object, or be hardcoded.
UserPatchExtension	getOverlayExtension()
protected java.lang.Iterable<java.lang.String>	getServerRunArgs() For run configurations
protected java.lang.String	getServerRunClass() For run configurations.
protected java.lang.String	getServerTweaker() For run configurations.
protected java.lang.String	getSrcDepName() Name of the source dependency.
protected java.lang.String	getSrgCacheDir(UserPatchExtension 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(UserPatchExtension exten) May invoke the extension object, or be hardcoded.
protected abstract java.lang.String	getVersionsJsonUrl() THIS HAPPENS EARLY! no delay tokens or stuff!
protected boolean	hasApiVersion() May invoke the extension object, or be hardcoded.
java.lang.String	resolve(java.lang.String pattern, org.gradle.api.Project project, UserPatchExtension exten)

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

afterEvaluate, configureCompilation, configureDeobfuscation, configureDeps, configureIntellij, delayedDirtyFile, delayedDirtyFile, getApiName, injectIntellijRuns, setMinecraftDeps

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

addFlatRepo, addMavenRepo, apply, applyExternalPlugin, 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

UserPatchBasePlugin

public UserPatchBasePlugin()

Method Detail

applyPlugin

public void applyPlugin()

Overrides:

applyPlugin in class UserBasePlugin<UserPatchExtension>

applyOverlayPlugin

public final void applyOverlayPlugin()

Specified by:

applyOverlayPlugin in class BasePlugin<UserPatchExtension>

canOverlayPlugin

public final boolean canOverlayPlugin()

Description copied from class: BasePlugin

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

Specified by:

canOverlayPlugin in class BasePlugin<UserPatchExtension>

Returns:

TRUE if this can be applied upon another base plugin.

getOverlayExtension

public final UserPatchExtension getOverlayExtension()

Specified by:

getOverlayExtension in class BasePlugin<UserPatchExtension>

Returns:

the extension object with name EXT_NAME_MC

See Also:

Constants.EXT_NAME_MC

delayedTaskConfig

protected void delayedTaskConfig()

Allows for the configuration of tasks in AfterEvaluate

Overrides:

delayedTaskConfig in class UserBasePlugin<UserPatchExtension>

doVersionChecks

protected void doVersionChecks(java.lang.String version)

Specified by:

doVersionChecks in class UserBasePlugin<UserPatchExtension>

Parameters:

version - may have pre-release suffix _pre#

doVersionChecks

protected abstract void doVersionChecks(java.lang.String version,
                                        int buildNumber)

getDevJson

protected DelayedFile getDevJson()

Specified by:

getDevJson in class BasePlugin<UserPatchExtension>

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<UserPatchExtension>

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<UserPatchExtension>

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<UserPatchExtension>

Returns:

has an api version

getApiCacheDir

protected java.lang.String getApiCacheDir(UserPatchExtension 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<UserPatchExtension>

Parameters:

exten - the extension object

Returns:

the API cache dir

getSrgCacheDir

protected java.lang.String getSrgCacheDir(UserPatchExtension 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<UserPatchExtension>

Parameters:

exten - the extension object

Returns:

the SRG cache dir

getUserDevCacheDir

protected java.lang.String getUserDevCacheDir(UserPatchExtension 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<UserPatchExtension>

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<UserPatchExtension>

Returns:

the userdev dep string

getExtensionClass

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

Description copied from class: BasePlugin

This extension object will have the name "minecraft"

Overrides:

getExtensionClass in class UserBasePlugin<UserPatchExtension>

Returns:

extension object class

getApiVersion

protected java.lang.String getApiVersion(UserPatchExtension 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<UserPatchExtension>

Parameters:

exten - the extension object

Returns:

the api version

getMcVersion

protected java.lang.String getMcVersion(UserPatchExtension 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<UserPatchExtension>

Parameters:

exten - the extension object

Returns:

the MC version

getVersionsJsonUrl

protected abstract java.lang.String getVersionsJsonUrl()

THIS HAPPENS EARLY! no delay tokens or stuff!

Returns:

url of the version json

getClientRunArgs

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

Description copied from class: UserBasePlugin

For run configurations

Specified by:

getClientRunArgs in class UserBasePlugin<UserPatchExtension>

Returns:

the client run arguments

getServerRunArgs

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

Description copied from class: UserBasePlugin

For run configurations

Specified by:

getServerRunArgs in class UserBasePlugin<UserPatchExtension>

Returns:

the server run arguments

configurePatching

protected abstract void configurePatching(ProcessSrcJarTask patch)

Add in the desired patching stages. This happens during normal evaluation, and NOT AfterEvaluate.

Parameters:

patch - patching task

getApiGroup

protected abstract java.lang.String getApiGroup()

Should be with separate with periods.

Returns:

API group

getApiPath

protected java.lang.String getApiPath(UserPatchExtension exten)

Should be with separate with slashes.

Parameters:

exten - extension object

Returns:

api path

getStartDir

protected java.lang.String getStartDir()

Description copied from class: UserBasePlugin

For run configurations

Specified by:

getStartDir in class UserBasePlugin<UserPatchExtension>

Returns:

the start location

getClientRunClass

protected java.lang.String getClientRunClass()

Description copied from class: UserBasePlugin

For run configurations. Is delayed.

Specified by:

getClientRunClass in class UserBasePlugin<UserPatchExtension>

Returns:

the client main class name

getClientTweaker

protected java.lang.String getClientTweaker()

Description copied from class: UserBasePlugin

For run configurations. Is delayed.

Specified by:

getClientTweaker in class UserBasePlugin<UserPatchExtension>

Returns:

the client tweaker class name

getServerTweaker

protected java.lang.String getServerTweaker()

Description copied from class: UserBasePlugin

For run configurations. Is delayed.

Specified by:

getServerTweaker in class UserBasePlugin<UserPatchExtension>

Returns:

the server tweaker class name

getServerRunClass

protected java.lang.String getServerRunClass()

Description copied from class: UserBasePlugin

For run configurations. Is delayed.

Specified by:

getServerRunClass in class UserBasePlugin<UserPatchExtension>

Returns:

the server main class name

resolve

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

Specified by:

resolve in interface DelayedBase.IDelayedResolver<UserPatchExtension>

Overrides:

resolve in class UserBasePlugin<UserPatchExtension>

configurePostDecomp

protected void configurePostDecomp(boolean decomp,
                                   boolean remove)

Description copied from class: UserBasePlugin

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

Overrides:

configurePostDecomp in class UserBasePlugin<UserPatchExtension>

Parameters:

decomp - will decompile this task

remove - should remove old dependencies or not