Gamebuster: Created page with "{{Mod|Mixin|Mods/SpongePowered Mixin|coremod=true}} = Annotation @Mixin = {| class="wikitable" |- |Fully Qualified Name || org.spongepower..."

2025-10-02T01:43:20Z

Created page with "{{Mod|Mixin|Mods/SpongePowered Mixin|coremod=true}} = Annotation @Mixin = {| class="wikitable" |- |Fully Qualified Name || <syntaxhighlight lang="java" inline>org.spongepower..."

New page

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

= Annotation @Mixin =
{| class="wikitable"
|-
|Fully Qualified Name || <syntaxhighlight lang="java" inline>org.spongepowered.asm.mixin.injection.Inject</syntaxhighlight>
|}

{| class="wikitable"
|+ Meta Annotations
|-
| <syntaxhighlight lang="java" inline>@Target</syntaxhighlight> || METHOD
|-
| <syntaxhighlight lang="java" inline>@Retention</syntaxhighlight> || RUNTIME
|}

<syntaxhighlight lang="java" inline>@Inject</syntaxhighlight> declares that a method is an injection callback method. This means that the code defined in this method should be injected into the some target method. This allows coremods to change the game's logic without editing the source code directly.
{| class="wikitable"
|+ Required Element Summary
|-
! Modifier and Type !! Element Name !! Description
|-
| <syntaxhighlight lang="java" inline>@At[]</syntaxhighlight>[https://javadoc.io/doc/net.fabricmc/sponge-mixin/latest/org/spongepowered/asm/mixin/injection/Inject.html] || at || Array of <syntaxhighlight lang="java" inline>@At</syntaxhighlight> annotations which describe the [[InjectionPoint|Injection Points]] in the target method.
|}
{| class="wikitable"
|+ Optional Element Summary
|-
! Modifier and Type !! Element Name !! Default !! Description
|-
| <syntaxhighlight lang="java" inline>int</syntaxhighlight> || allow || <syntaxhighlight lang="java" inline>-1</syntaxhighlight> || Injection points by default are expected to match every candidate instruction in the target method or slice, except in cases where such options such as <syntaxhighlight lang="java" inline>@At.ordinal()</syntaxhighlight> are specified which by definition limit the number of results. This option limits the maximum number of matches for this injector. Setting any value 1 or greater is allowed. Values less than 1 or less than <syntaxhighlight lang="java" inline>require()</syntaxhighlight> are ignored.
|-
| <syntaxhighlight lang="java" inline>boolean</syntaxhighlight> || cancellable || <syntaxhighlight lang="java" inline>false</syntaxhighlight> || Allows this injection callback to be cancellable, meaning it can inject RETURN opcodes into the target method. Return behavior can then be controlled from within the callback by interacting with the [[CallbackInfo]] object.
|-
| <syntaxhighlight lang="java" inline>String</syntaxhighlight>[https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html] || constraints || <syntaxhighlight lang="java" inline>""</syntaxhighlight> || The constraints[https://javadoc.io/static/net.fabricmc/sponge-mixin/0.16.4+mixin.0.8.7/org/spongepowered/asm/util/ConstraintParser.Constraint.html] which must be validated for this injector to succeed.
|-
| <syntaxhighlight lang="java" inline>int</syntaxhighlight>|| expect || <syntaxhighlight lang="java" inline>1</syntaxhighlight> || Like <syntaxhighlight lang="java" inline>require</syntaxhighlight>, but only enabled if <syntaxhighlight lang="java" inline>mixin.debug.countInjections</syntaxhighlight> is set to <syntaxhighlight lang="java" inline>true</syntaxhighlight>. Unlike <syntaxhighlight lang="java" inline>require()</syntaxhighlight>, defaults to <syntaxhighlight lang="java" inline>1</syntaxhighlight>.
|-
| <syntaxhighlight lang="java" inline>String</syntaxhighlight>[https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html] || id || <syntaxhighlight lang="java" inline>""</syntaxhighlight> || The identifier for this injector. Can be retrieved by calling <syntaxhighlight lang="java" inline>CallbackInfo.getId()</syntaxhighlight>.
|-
| <syntaxhighlight lang="java" inline>LocalCapture</syntaxhighlight>[https://javadoc.io/static/net.fabricmc/sponge-mixin/0.16.4+mixin.0.8.7/org/spongepowered/asm/mixin/injection/callback/LocalCapture.html] || locals || <syntaxhighlight lang="java" inline>{}</syntaxhighlight> || Deprecated. Specifies the local variable capture variable behavior for this injector. Use [[@Local]] instead.
|-
| <syntaxhighlight lang="java" inline>String[]</syntaxhighlight>[https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html] || method || <syntaxhighlight lang="java" inline>{}</syntaxhighlight> || String representation of one or more [[Target Selectors]] which identify the target methods.
|-
| <syntaxhighlight lang="java" inline>int</syntaxhighlight> || order || <syntaxhighlight lang="java" inline>1000</syntaxhighlight> || By default almost all injectors for a target class apply their injections at the same time. If multiple mixins target the same class, then the injectors are applied in priority order. The default order for injectors is <syntaxhighlight lang="java" inline>1000</syntaxhighlight>.

Specifying a value for <syntaxhighlight lang="java" inline>order</syntaxhighlight> causes the injector to inject earlier or later than it normally would. Specifying a lower number will cause the injector to apply earlier, and a higher number will cause it to apply later. Injectors with the same order will still apply in the order of their mixin's priority.
|-
| <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>int</syntaxhighlight>|| require || <syntaxhighlight lang="java" inline>-1</syntaxhighlight> || Generally, injectors are intended to fail softly. However this is not always desirable. This parameter allows you to stipulate a '''minimum''' amount of successful injections for this callback handler. If the number of injections specified is not achieved, then an <syntaxhighlight lang="java" inline>InjectionError</syntaxhighlight> is thrown at classload time.
|-
| <syntaxhighlight lang="java" inline>Slice[]</syntaxhighlight> [https://javadoc.io/static/net.fabricmc/sponge-mixin/0.16.4+mixin.0.8.7/org/spongepowered/asm/mixin/injection/Slice.html] || slice || <syntaxhighlight lang="java" inline>{}</syntaxhighlight> || Array of [[@Slice]] annotations which describe the method bisections used in the <syntaxhighlight lang="java" inline>at()</syntaxhighlight> queries for this injector.
|-
| <syntaxhighlight lang="java" inline>Desc[]</syntaxhighlight> [https://javadoc.io/static/net.fabricmc/sponge-mixin/0.16.4+mixin.0.8.7/org/spongepowered/asm/mixin/injection/Desc.html] || target || <syntaxhighlight lang="java" inline>{}</syntaxhighlight> || Literal representation of one or more [[@Desc]] annotations which identify the target methods
|-
|}

Mods/SpongePowered Mixin/@Inject - Revision history

Gamebuster: Created page with "{{Mod|Mixin|Mods/SpongePowered Mixin|coremod=true}} = Annotation @Mixin = {| class="wikitable" |- |Fully Qualified Name || org.spongepower..."