net.minecraftforge.gradle.user

Interface IReobfuscator

All Known Implementing Classes:

ReobfTaskFactory.ReobfTaskWrapper

public interface IReobfuscator

Used to create a base interface for the reobf task and config classes so that things can be copy-pasted between the two.

Method Summary

Modifier and Type	Method and Description
void	extraFiles(java.lang.Iterable<java.lang.Object> o) Adds a collection of additional srg files for reobfuscating.
void	extraFiles(java.lang.Object... o) Adds some additional srg files for reobfuscating.
void	extraLines(java.lang.Iterable<java.lang.Object> o) Adds a collection of additional srg lines for reobfuscating.
void	extraLines(java.lang.Object... o) Adds some additional srg lines for reobfuscating.
org.gradle.api.file.FileCollection	getClasspath() Gets the classpath used to reobfuscate.
java.util.List<java.lang.Object>	getExtraFiles() Gets the extra srg files.
java.util.List<java.lang.Object>	getExtraLines() Gets the extra srg lines and files.
java.lang.Object	getMappings() Gets the mappings file used to reobfuscate.
ReobfMappingType	getMappingType() Gets the mappings type.
void	setClasspath(org.gradle.api.file.FileCollection classpath) Sets the classpath used to reobfuscate.
void	setExtraLines(java.util.List<java.lang.Object> extra) Sets the extra lines.
void	setMappings(java.lang.Object srg) Sets the mappings file used to reobfuscate.
void	setMappingType(ReobfMappingType type) Sets the mapping type for easy access to searge or notch names.
void	useNotchSrg() Deprecated. Use setMappingType(ReobfMappingType)
void	useSrgSrg() Deprecated. Use setMappingType(ReobfMappingType)

Method Detail

getMappings

java.lang.Object getMappings()

Gets the mappings file used to reobfuscate. It should be either a File or a String path for a DelayedFile.

Returns:

The srg file or path to it

setMappings

void setMappings(java.lang.Object srg)

Sets the mappings file used to reobfuscate. It should be either a String or File.

Parameters:

srg - The srg file or path to it

getMappingType

ReobfMappingType getMappingType()

Gets the mappings type.

Returns:

The mapping type

setMappingType

void setMappingType(ReobfMappingType type)

Sets the mapping type for easy access to searge or notch names. For custom mappings, use setMappings(Object).

 // for notch names (vanilla)
 mappingType = "NOTCH"

 // or searge names (forge)
 mappingType = "SEARGE"
 

Parameters:

type - The mapping

Throws:

java.lang.NullPointerException - when type is null

java.lang.IllegalArgumentException - when type is ReobfMappingType.CUSTOM

setClasspath

void setClasspath(org.gradle.api.file.FileCollection classpath)

Sets the classpath used to reobfuscate. This is used by groovy for simplicity. Use classpath += otherClasspath to add to it.

Parameters:

classpath - The new classpath

getClasspath

org.gradle.api.file.FileCollection getClasspath()

Gets the classpath used to reobfuscate. Use classpath += otherClasspath to add to it.

Returns:

The classpath

getExtraLines

java.util.List<java.lang.Object> getExtraLines()

Gets the extra srg lines and files. Modders should prefer to use extraLines(Object...) or extra += [] instead of setting the list manually.

Returns:

The extra srg lines

setExtraLines

void setExtraLines(java.util.List<java.lang.Object> extra)

Sets the extra lines. Modders should prefer to use extraLines(Object...) instead of setting the list manually.

Parameters:

extra - The list of srg lines

extraLines

void extraLines(java.lang.Object... o)

Adds some additional srg lines for reobfuscating. These are resolved to strings.

Parameters:

o - The array to add

extraLines

void extraLines(java.lang.Iterable<java.lang.Object> o)

Adds a collection of additional srg lines for reobfuscating.

Parameters:

o - The collection to add

getExtraFiles

java.util.List<java.lang.Object> getExtraFiles()

Gets the extra srg files. Modders should prefer to use extraFiles(Object...) instead of setting the list manually.

Returns:

The extra srg files

extraFiles

void extraFiles(java.lang.Object... o)

Adds some additional srg files for reobfuscating. These are resolved to files with Project.file(Object)

Parameters:

o - The array to add

extraFiles

void extraFiles(java.lang.Iterable<java.lang.Object> o)

Adds a collection of additional srg files for reobfuscating.

Parameters:

o - The collection to add

useSrgSrg

@Deprecated
void useSrgSrg()

Deprecated. Use setMappingType(ReobfMappingType)

Sets the mappings to use Searge names. This is the default with the Forge plugin. i.e. Minecraft.func_71410_x()

useNotchSrg

@Deprecated
void useNotchSrg()

Deprecated. Use setMappingType(ReobfMappingType)

Sets the mappings to use Notch names. Useful for mods that want to be able to run without Forge installed, such as libraries or hybrid mods. i.e. bsu.z()