Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:mixin_examples

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
tutorial:mixin_examples [2024/01/12 23:26] – arkosammy12tutorial:mixin_examples [2026/05/16 08:25] (current) – Clarify that using shift by is discouraged. earthcomputer
Line 1: Line 1:
 +FIXME //The Fabric Wiki's Mixin segments is under heavy reviews, pages on the topic are subject to major edits or rewrites. This page in particular is noted as being unreliable to learn Mixin as a tool from. Learning by example should be used sparingly, as it may lead to a lack of understanding. Prioritize, if you are unable to learn through documentation, presenting your intention in detail in a Mixin support channel on the Fabric or SpongePowered Discord servers and discussing with experienced devs there.//
 +
 +
 +:!: //A rewrite of this page is planned and will be drafted in the foreseeable future, whilst some quicker changes and improvements may be applied to this page in the process, more fundamental structural changes will happen as part of a broader rewrite and replacement by a new version of the page//
 +
 ====== Mixin Examples ====== ====== Mixin Examples ======
 This is a collection of frequently used mixins. This is a collection of frequently used mixins.
Line 148: Line 153:
  
 ===== Injecting into the point with shift amount ===== ===== Injecting into the point with shift amount =====
 +:!: Using a shift amount is heavily discouraged, instead you should find a more descriptive/precise injection point.
 +
 Mixin: Mixin:
 <code java> <code java>
Line 272: Line 279:
  
 ==== Capture locals with MixinExtras ==== ==== Capture locals with MixinExtras ====
 +:!: See the oficial MixinExtra's [[https://github.com/LlamaLad7/MixinExtras/wiki/Local|Wiki]].
 +
 :!: MixinExtras required Fabric Loader 0.15 or above, or you have to manually specify it in ''build.gradle''. :!: MixinExtras required Fabric Loader 0.15 or above, or you have to manually specify it in ''build.gradle''.
  
 :!: If there are multiple locals with that type, you have to specify ''ordinal'' or it will throw an error. :!: If there are multiple locals with that type, you have to specify ''ordinal'' or it will throw an error.
  
-:!: More information about MixinExtra's ''@Local'' annotation can be found in its [[https://github.com/LlamaLad7/MixinExtras/wiki/Local|Wiki]].+:!: the use of ''@Local'' is recommended over ''LocalCapture''
  
 Mixin: Mixin:
Line 282: Line 291:
 @Inject(method = "foo()V", at = @At(value = "TAIL")) @Inject(method = "foo()V", at = @At(value = "TAIL"))
 private void injected(CallbackInfo ci, @Local TypeArg2 arg2) { private void injected(CallbackInfo ci, @Local TypeArg2 arg2) {
-  arg1.doSomething4();+  arg2.doSomething4();
 } }
 </code> </code>
Line 303: Line 312:
 @Inject(method = "foo()V", at = @At(value = "TAIL")) @Inject(method = "foo()V", at = @At(value = "TAIL"))
 private void injected(CallbackInfo ci, @Local(ordinal = 2) TypeArg arg) { private void injected(CallbackInfo ci, @Local(ordinal = 2) TypeArg arg) {
-  arg1.doSomething4();+  arg.doSomething4();
 } }
 </code> </code>
Line 342: Line 351:
 Mixin: Mixin:
 <code java> <code java>
-@Inject(method = "foo()I;", at = @At("RETURN"), cancellable = true) +@ModifyReturnValue(method = "foo", at = @At("RETURN")) 
-private void injected(CallbackInfoReturnable<Integer> cir) { +private int exampleModifyReturnValue(int original) { 
-  cir.setReturnValue(cir.getReturnValue() * 3);+    return original * 3;
 } }
 </code> </code>
Line 350: Line 359:
 Result: Result:
 <code diff> <code diff>
-  public int foo() {+public int foo() {
     doSomething1();     doSomething1();
     doSomething2();     doSomething2();
 -   return doSomething3() + 7; -   return doSomething3() + 7;
-+   int i = doSomething3() + 7; ++   return this.exampleModifyReturnValue(doSomething3() + 7); 
-+   CallbackInfoReturnable<Integer> cir = new CallbackInfoReturnable<Integer>("foo", true, i); +}
-+   injected(cir); +
-+   if (cir.isCancelled()) return cir.getReturnValue(); +
-+   return i; +
-  }+
 </code> </code>
  
tutorial/mixin_examples.1705101994.txt.gz · Last modified: 2024/01/12 23:26 by arkosammy12