Package org.spongepowered.asm.mixin.extensibility

Interface IMixinConfig

public interface IMixinConfig
Interface for loaded mixin configurations

  • Field Summary

    Fields
    Modifier and Type Field Description
    static int DEFAULT_PRIORITY
    Default priority for mixin configs and mixins

  • Method Summary

    Modifier and Type Method Description
    MixinEnvironment getEnvironment()
    Get the parent environment of this config
    java.lang.String getMixinPackage()
    Get the package containing all mixin classes
    java.lang.String getName()
    Get the name of the file from which this configuration object was initialised
    IMixinConfigPlugin getPlugin()
    Get the companion plugin, if available
    int getPriority()
    Get the priority
    java.util.Set<java.lang.String> getTargets()
    Get targets for this configuration
    boolean isRequired()
    True if this mixin is required (failure to apply a defined mixin is an error condition).

  • Field Details

    • DEFAULT_PRIORITY

      static final int DEFAULT_PRIORITY
      Default priority for mixin configs and mixins
      See Also:
      Constant Field Values

  • Method Details

    • getEnvironment

      MixinEnvironment getEnvironment()
      Get the parent environment of this config
      Returns:
      the parent environment

    • getName

      java.lang.String getName()
      Get the name of the file from which this configuration object was initialised
      Returns:
      the config filename (resource name)

    • getMixinPackage

      java.lang.String getMixinPackage()
      Get the package containing all mixin classes
      Returns:
      the base package name for this config

    • getPriority

      int getPriority()
      Get the priority
      Returns:
      the priority

    • getPlugin

      IMixinConfigPlugin getPlugin()
      Get the companion plugin, if available
      Returns:
      the companion plugin instance or null if no plugin

    • isRequired

      boolean isRequired()
      True if this mixin is required (failure to apply a defined mixin is an error condition).
      Returns:
      true if this config is marked as required

    • getTargets

      java.util.Set<java.lang.String> getTargets()
      Get targets for this configuration
      Returns:
      target classes of mixins in this config