Class UtilityModule

java.lang.Object

com.gtnewhorizons.gtnhgradle.modules.UtilityModule

All Implemented Interfaces:

GTNHModule

public class UtilityModule
extends Object
implements GTNHModule

Provides utility tasks and functions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UtilityModule.GroovyDeobf	Groovy-callable wrapper for deobf(Project, String) and deobf(Project, String, String)
static class	UtilityModule.GroovyDeobfCurse	Groovy-callable wrapper for deobfCurse(Project, String)
static class	UtilityModule.GroovyDeobfMaven	Groovy-callable wrapper for deobfMaven(Project, String, String)

Constructor Summary

Constructors

Constructor	Description
UtilityModule()

Method Summary

Modifier and Type	Method	Description
void	apply(@NotNull GTNHGradlePlugin.GTNHExtension gtnh, @NotNull Project project)	Activates this module on the given project.
static Object	deobf(Project project, String sourceURL)	Deprecated URL-based deobfuscation wrapper
static Object	deobf(Project project, String sourceURL, String rawFileName)	Deprecated URL-based deobfuscation wrapper
static Object	deobfCurse(Project project, String curseDep)	Thin wrapper around cursemaven and rfg.deobf.
static Object	deobfMaven(Project project, String repoURL, String mavenDep)	Deprecated by rfg.deobf, deobfuscate a maven dependency
boolean	isEnabled(@NotNull PropertiesConfiguration configuration)
static int	replaceParams(Logger logger, File file, Map<String,String> params)	Replace SRG param names with MCP names

Methods inherited from class Object

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

Constructor Details

UtilityModule

public UtilityModule()

Method Details

isEnabled

public boolean isEnabled(@NotNull
 @NotNull PropertiesConfiguration configuration)

Specified by:

isEnabled in interface GTNHModule

Parameters:

configuration - The project configuration

Returns:

If this module should be enabled for the input project settings

apply

public void apply(@NotNull GTNHGradlePlugin.GTNHExtension gtnh,
 @NotNull
 @NotNull Project project)
           throws Throwable

Description copied from interface: GTNHModule

Activates this module on the given project.

Specified by:

apply in interface GTNHModule

Parameters:

gtnh - The GTNH extension providing access to various gradle services and configuration

project - The project to activate the module on

Throws:

Throwable - Any exception to allow easier module writing

replaceParams

public static int replaceParams(Logger logger,
 File file,
 Map<String,String> params)

Replace SRG param names with MCP names

Parameters:

logger - Logger to use

file - Directory to scan

params - SRG to MCP mappings

Returns:

Files changed count

deobf

public static Object deobf(Project project,
 String sourceURL)

Deprecated URL-based deobfuscation wrapper

Parameters:

project - Gradle project to use

sourceURL - The obfuscated jar URL

Returns:

A dependency specification for the deobfed jar

deobf

public static Object deobf(Project project,
 String sourceURL,
 String rawFileName)

Deprecated URL-based deobfuscation wrapper

Parameters:

project - Gradle project to use

sourceURL - The obfuscated jar URL

rawFileName - Name for the file to cache

Returns:

A dependency specification for the deobfed jar

deobfMaven

public static Object deobfMaven(Project project,
 String repoURL,
 String mavenDep)

Deprecated by rfg.deobf, deobfuscate a maven dependency

Parameters:

project - Gradle project to use

repoURL - URL of the maven repository

mavenDep - GAV coordinates for the jar to deobfuscate

Returns:

A dependency specification for the deobfed jar

deobfCurse

public static Object deobfCurse(Project project,
 String curseDep)

Thin wrapper around cursemaven and rfg.deobf.

Parameters:

project - Gradle project to use

curseDep - The curse PROJECT-FILE id pair

Returns:

A dependency specification for the deobfed jar