Interface DeobfExtension

@Experimental public sealed interface DeobfExtension

The extension for working with deobfuscation in ForgeGradle. It is automatically applied by the minecraft extension when a Minecraft dependency is declared.

Deobfuscation is a necessary part of working with Forge for Minecraft 1.20.4 and older. This extension is designed to make that burden as little as possible.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
    The name for this extension in Gradle.

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(Object value)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated.
    org.gradle.api.artifacts.ExternalModuleDependency
    deobf(Object value, Closure closure)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and configures it with the given closure.
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(Object value, org.gradle.api.Action<? super org.gradle.api.artifacts.Dependency> action)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and applies the given action to it.
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(org.gradle.api.provider.Provider<?> value)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated.
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(org.gradle.api.provider.Provider<?> value, Closure closure)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and configures it with the given closure.
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(org.gradle.api.provider.Provider<?> value, org.gradle.api.Action<? super org.gradle.api.artifacts.Dependency> action)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and applies the given action to it.
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(org.gradle.api.provider.ProviderConvertible<?> value)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated.
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(org.gradle.api.provider.ProviderConvertible<?> value, Closure closure)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and configures it with the given closure.
    default org.gradle.api.artifacts.ExternalModuleDependency
    deobf(org.gradle.api.provider.ProviderConvertible<?> value, org.gradle.api.Action<? super org.gradle.api.artifacts.Dependency> action)
    Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and applies the given action to it.

  • Field Details

  • Method Details

    • deobf

      org.gradle.api.artifacts.ExternalModuleDependency deobf(Object value, @DelegatesTo(org.gradle.api.artifacts.Dependency.class) Closure closure)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and configures it with the given closure.
      Parameters:
      value - The dependency
      closure - The closure to configure the dependency with
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(Object value, org.gradle.api.Action<? super org.gradle.api.artifacts.Dependency> action)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and applies the given action to it.
      Parameters:
      value - The dependency
      action - The action to apply to the dependency attributes
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(Object value)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated.
      Parameters:
      value - The dependency
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(org.gradle.api.provider.Provider<?> value, @DelegatesTo(org.gradle.api.artifacts.Dependency.class) Closure closure)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and configures it with the given closure.
      Parameters:
      value - The dependency
      closure - The closure to configure the dependency with
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(org.gradle.api.provider.Provider<?> value, org.gradle.api.Action<? super org.gradle.api.artifacts.Dependency> action)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and applies the given action to it.
      Parameters:
      value - The dependency
      action - The action to apply to the dependency attributes
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(org.gradle.api.provider.Provider<?> value)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated.
      Parameters:
      value - The dependency
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(org.gradle.api.provider.ProviderConvertible<?> value, @DelegatesTo(org.gradle.api.artifacts.Dependency.class) Closure closure)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and configures it with the given closure.
      Parameters:
      value - The dependency
      closure - The closure to configure the dependency with
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(org.gradle.api.provider.ProviderConvertible<?> value, org.gradle.api.Action<? super org.gradle.api.artifacts.Dependency> action)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated and applies the given action to it.
      Parameters:
      value - The dependency
      action - The action to apply to the dependency attributes
      Returns:
      The dependency
      See Also:

    • deobf

      default org.gradle.api.artifacts.ExternalModuleDependency deobf(org.gradle.api.provider.ProviderConvertible<?> value)
      Creates (or marks if existing) the given dependency as an obfuscated dependency to be deobfuscated.
      Parameters:
      value - The dependency
      Returns:
      The dependency
      See Also: