Interface MixinSourceSetConfig

All Known Subinterfaces:
MixinConfig
public interface MixinSourceSetConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gradle.api.provider.Property<String>
    getDefaultObfuscationEnv()
    The current workspace mapping type, used so that Mixin can translate your obfuscated names for creating the refmap
    org.gradle.api.provider.Property<Boolean>
    getDisableOverwriteChecker()
    By default, when a Mixin target is annotated with @Overwrite, it is enforced that a Javadoc block above it contains at least an @author and @reason tag.
    org.gradle.api.provider.Property<Boolean>
    getDisableTargetExport()
    Prevents the annotation processor from creating a small .csv file with data pertaining to annotation processing.
    org.gradle.api.provider.Property<Boolean>
    getDisableTargetValidator()
    Stops the Mixin annotation processor from throwing an error when it finds an invalid Mixin target
    org.gradle.api.file.ConfigurableFileCollection
    getExtraMappings()
    Extra mapping files to use for creating refmaps, usually for obfuscated external dependencies
    org.gradle.api.provider.ListProperty<String>
    getMappingTypes()
    The other half of getDefaultObfuscationEnv(), the output mapping type to translate to for creating entries in the refmap
    org.gradle.api.provider.MapProperty<String,String>
    getMessages()
    Which message types to hide, warn about or simply display.
    org.gradle.api.provider.Property<String>
    getOverwriteErrorLevel()
    The level of complaining the Mixin annotation processor will do when it finds an @Overwrite annotated target lacking the @author and @reason tags.
    org.gradle.api.provider.Property<Boolean>
    getQuiet()
    "Quietens" the console by suppressing trivial and often unneeded messages
    org.gradle.api.provider.Property<String>
    getRefMap()
    The reference mapping for this source set.
    org.gradle.api.provider.Property<Boolean>
    getShowMessageTypes()
    Prefix mixin logs with the type of message, such as [MIXIN_0100] which refers to a missing @author tag
    org.gradle.api.provider.MapProperty<String,String>
    getTokens()
    Extra data passed to the compiler as key-value pairs.

  • Method Details

    • getRefMap

      org.gradle.api.provider.Property<String> getRefMap()
      The reference mapping for this source set. Will inform Mixin of which symbols are mapped to which names at runtime

    • getDisableTargetValidator

      org.gradle.api.provider.Property<Boolean> getDisableTargetValidator()
      Stops the Mixin annotation processor from throwing an error when it finds an invalid Mixin target

    • getDisableTargetExport

      org.gradle.api.provider.Property<Boolean> getDisableTargetExport()
      Prevents the annotation processor from creating a small .csv file with data pertaining to annotation processing. Keeping this on will make the AP run slightly faster, but may be worth turning off if you are getting AP file access errors

    • getDisableOverwriteChecker

      org.gradle.api.provider.Property<Boolean> getDisableOverwriteChecker()
      By default, when a Mixin target is annotated with @Overwrite, it is enforced that a Javadoc block above it contains at least an @author and @reason tag. Turning this off will prevent Mixin from complaining (ignore, warn or error, see getOverwriteErrorLevel()) in such a case where these tags are missing

    • getOverwriteErrorLevel

      org.gradle.api.provider.Property<String> getOverwriteErrorLevel()
      The level of complaining the Mixin annotation processor will do when it finds an @Overwrite annotated target lacking the @author and @reason tags. Can be any of the following:
      • ignore: Do nothing
      • warning: Write a warning message to the console
      • error: Throw an error

    • getDefaultObfuscationEnv

      org.gradle.api.provider.Property<String> getDefaultObfuscationEnv()
      The current workspace mapping type, used so that Mixin can translate your obfuscated names for creating the refmap

    • getMappingTypes

      org.gradle.api.provider.ListProperty<String> getMappingTypes()
      The other half of getDefaultObfuscationEnv(), the output mapping type to translate to for creating entries in the refmap

    • getTokens

      org.gradle.api.provider.MapProperty<String,String> getTokens()
      Extra data passed to the compiler as key-value pairs. These extra data can then be used in annotation parameters.

      Example :@Inject(method = "foo" at = @At("HEAD"), constraints="myToken(myValue)"

    • getExtraMappings

      org.gradle.api.file.ConfigurableFileCollection getExtraMappings()
      Extra mapping files to use for creating refmaps, usually for obfuscated external dependencies

    • getQuiet

      org.gradle.api.provider.Property<Boolean> getQuiet()
      "Quietens" the console by suppressing trivial and often unneeded messages

    • getShowMessageTypes

      org.gradle.api.provider.Property<Boolean> getShowMessageTypes()
      Prefix mixin logs with the type of message, such as [MIXIN_0100] which refers to a missing @author tag

    • getMessages

      org.gradle.api.provider.MapProperty<String,String> getMessages()
      Which message types to hide, warn about or simply display. These can be seen by enabling getShowMessageTypes()

      Example: "MIXIN_0100": "ignore"