Differences

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

--- tutorial:mixin_examples [2023/10/12 06:17] – Add note to double casting example daomephsta
+++ tutorial:mixin_examples [2024/11/18 15:52] (current) – fixed some of the argument names in mixinextra section bemoty
@@ Line 14: / Line 14: @@
 ===== Access the this instance of the class your mixin is targeting =====
-Note: Double casting ''this'' should be avoided when possible.
+Note: Double casting ''this'' should be avoided when possible. If you intend to use a method or field from the target class, use ''@Shadow''. If the method or field is from a parent of the target class, have your mixin extend the direct parent of the target class.
-If the method or field is from the target class, use `@Shadow`
-If the method or field is from a parent of the target class, have your mixin extend the direct parent of the target class.
 Mixin:
@@ Line 24: / Line 22: @@
   @Inject(method = "foo()V", at = @At("HEAD"))
   private void injected(CallbackInfo ci) {
-    ((TargetClass)(Object)this).methodOfTheTargetClass();
+    TargetClass thisObject = (TargetClass)(Object)this;
   }
 }
@@ Line 149: / Line 147: @@
 </code>
-===== Injecting into the point before a method call with shift amount =====
+===== Injecting into the point with shift amount =====
 Mixin:
 <code java>
@@ Line 250: / Line 248: @@
 ===== Capturing local values =====
+==== Capture locals without MixinExtras ====
 Mixin:
@@ Line 272: / Line 271: @@
 </code>
+==== 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''.
+:!: If there are multiple locals with that type, you have to specify ''ordinal'' or it will throw an error.
+Mixin:
+<code java>
+@Inject(method = "foo()V", at = @At(value = "TAIL"))
+private void injected(CallbackInfo ci, @Local TypeArg2 arg2) {
+  arg2.doSomething4();
+}
+</code>
+Result:
+<code diff>
+  public void foo() {
+    TypeArg1 arg1 = getArg1();
+    arg1.doSomething1();
+    arg1.doSomething2();
+    TypeArg2 arg2 = getArg2();
+    arg2.doSomething3();
++   injected(new CallbackInfo("foo", false), arg2);
+  }
+</code>
+==== Capturing one of multiple locals of a type ====
+Mixin:
+<code java>
+@Inject(method = "foo()V", at = @At(value = "TAIL"))
+private void injected(CallbackInfo ci, @Local(ordinal = 2) TypeArg arg) {
+  arg.doSomething4();
+}
+</code>
+Result:
+<code diff>
+  public void foo() {
+    TypeArg arg1 = getArg1();
+    TypeArg arg2 = getArg2();
+    TypeArg arg3 = getArg3();
+    TypeArg arg4 = getArg4();
+    doSomething();
++   injected(new CallbackInfo("foo", false), arg3);
+  }
+</code>
+===== Modifying locals =====
+This requires MixinExtras.
+Mixin:
+<code java>
+  @Inject(method = "foo()V", at = @At(value = "INVOKE", target = "doSomething()V", shift = At.Shift.AFTER))
+  private static void injected(CallbackInfo ci, @Local LocalRef<String> localRef) {
+    localRef.set(localRef.get() + " - modified")
+  }
+</code>
+Result:
+<code diff>
+  public void foo() {
+    String s = "example string";
+    doSomething();
++   s = s + " - modified";
+    doSomething2(s);
+  }
+</code>
 ===== Modifying a return value =====
 Mixin: