Mods/SpongePowered Mixin/@Mixin - Revision history

Gamebuster: Fix default values

2025-10-02T00:14:46Z

Fix default values

Gamebuster at 07:52, 18 September 2025

2025-09-18T07:52:21Z

Gamebuster at 07:51, 18 September 2025

2025-09-18T07:51:21Z

Gamebuster: Gamebuster moved page Mods/SpongePoweredMixin/@Mixin to Mods/SpongePowered Mixin/@Mixin: Incorrect Title

2025-09-18T07:45:24Z

← Older revision

Revision as of 07:45, 18 September 2025

Gamebuster: Created page with "{{Mod|Mixin|Mods/SpongePowered Mixin|coremod=true}} = Annotation @Mixin = {| class="wikitable" |+ Meta Annotations |- | @Target
2025-09-18T07:43:23Z

Created page with "{{Mod|Mixin|Mods/SpongePowered Mixin|coremod=true}} = Annotation @Mixin = {| class="wikitable" |+ Meta Annotations |- | <syntaxhighlight lang="java" inline>@Target</syntaxhig..."

New page
{{Mod|Mixin|Mods/SpongePowered Mixin|coremod=true}}

= Annotation @Mixin =
{| class="wikitable"
|+ Meta Annotations
|-
| <syntaxhighlight lang="java" inline>@Target</syntaxhighlight> || TYPE
|-
| <syntaxhighlight lang="java" inline>@Retention</syntaxhighlight> || CLASS
|}

The main decorator for defining a mixin. This annotation defines a class as a mixin class. Mixin classes are not traditional classes, as they cannot be referenced at runtime (With the exception of [[Mods/SpongePowered Mixin/Accessor Mixin|Accessor Mixins]]). Instead, when a class targeted by a mixin is classloaded, the transformations defined within this mixin are applied to the target class.

Every mixin requires at least one target class in order to be valid. Target classes can be specified using class literals in <syntaxhighlight lang="java" inline>value</syntaxhighlight>. If a target class is not publicly available at compile time, it may be specified in <syntaxhighlight lang=java" inline>targets</syntaxhighlight> instead.

{| class="wikitable"
|+ Element Summary
|-
! Modifier and Type !! Element Name !! Default !! Description
|-
| <syntaxhighlight lang="java" inline>int</syntaxhighlight> || priority || <syntaxhighlight lang="java" inline>1000</syntaxhighlight> || Priority for the mixin, relative to other mixins targeting the same classes.
|-
| <syntaxhighlight lang="java" inline>boolean</syntaxhighlight> || remap || <syntaxhighlight lang="java" inline>true</syntaxhighlight> || Used for obfuscation. Since Wildermyth is not obfuscated, you never need to worry about this.
|-
| <syntaxhighlight lang="java" inline>String</syntaxhighlight>[https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html] || targets || <syntaxhighlight lang="java" inline>{}</syntaxhighlight> || This property allows you to specify package-private, anonymous inner, private inner, unavailable [[@Pseudo]] classes, or any other classes that cannot be directly referenced at compile time.
|-
| <syntaxhighlight lang="java" inline>Class<?></syntaxhighlight>[https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html] || value || <syntaxhighlight lang="java" inline>{}</syntaxhighlight> || Target classes for this mixin
|-
|}

==Explanation==
Suppose we have this class:
<syntaxhighlight lang="java" line>
public class Example {

public static void printFoo() {
System.out.println("Foo");
}

}
</syntaxhighlight>

And we want to change the behavior it that "Foo" and "Bar" are printed. We can target the class with <syntaxhighlight lang="java" inline>@Mixin</syntaxhighlight>, then [[@Inject]] at the tail of the method to do so.

<syntaxhighlight lang="java" line>
@Mixin(Example.class) //Example.class is our target class
public class FooBarMixin {

@Inject( //We are injecting
method = "printFoo", //into the 'printFoo' method
at = @At("TAIL") //at the tail end of the method
)
private static void makeFooAlsoPrintBar(CallbackInfo callback) {
System.out.println("Bar");
}

}
</syntaxhighlight>

This effectively changes the logic of <syntaxhighlight lang="java" inline>Example.class</syntaxhighlight> to:

<syntaxhighlight lang="java" line highlight=5>
public class Example {

public static void printFoo() {
System.out.println("Foo");
System.out.println("Bar");
}

}
</syntaxhighlight>

Executing <syntaxhighlight lang="java" inline>Example.printFoo();</syntaxhighlight> would then print the following:

<pre>
Foo
Bar
</pre>