tutorial:mixin_examples
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
tutorial:mixin_examples [2021/08/31 20:14] – Added example of accessing the instance of the class the mixin is mixing into lvanderzande | tutorial:mixin_examples [2023/12/18 02:10] – [Injecting into the point before a method call with shift amount] solidblock | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Mixin Examples ====== | ====== Mixin Examples ====== | ||
This is a collection of frequently used mixins. | This is a collection of frequently used mixins. | ||
+ | This page is intended as a cheat sheet. | ||
+ | See [[tutorial: | ||
+ | |||
+ | ===== Mixing into a private inner class ===== | ||
+ | Use the targets parameter and a '' | ||
+ | <code java> | ||
+ | @Mixin(targets = " | ||
+ | public class AmbientOcclusionCalculatorMixin { | ||
+ | // do your stuff here | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Access the this instance of the class your mixin is targeting ===== | ||
+ | Note: Double casting '' | ||
- | ===== Access `this` instance of the class you're mixing into within a mixin class ===== | ||
Mixin: | Mixin: | ||
<code java> | <code java> | ||
- | @Mixin(ClassImMixingInto.class) | + | @Mixin(TargetClass.class) |
- | public class MyMixin { | + | public class MyMixin |
@Inject(method = " | @Inject(method = " | ||
private void injected(CallbackInfo ci) { | private void injected(CallbackInfo ci) { | ||
- | ((ClassImMixingInto)(Object)this).classImMixingIntoFunction(); | + | |
} | } | ||
} | } | ||
</ | </ | ||
+ | ===== Injecting into the head of a static block ===== | ||
+ | Mixin: | ||
+ | <code java> | ||
+ | @Inject(method = "< | ||
+ | private void injected(CallbackInfo ci) { | ||
+ | doSomething3(); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Result: | ||
+ | <code diff> | ||
+ | static { | ||
+ | + | ||
+ | doSomething1(); | ||
+ | doSomething2(); | ||
+ | } | ||
+ | </ | ||
===== Injecting into the head of a method ===== | ===== Injecting into the head of a method ===== | ||
Line 114: | Line 144: | ||
+ | + | ||
doSomething2(); | doSomething2(); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Injecting into the point with shift amount ===== | ||
+ | Mixin: | ||
+ | <code java> | ||
+ | @Inject(method = " | ||
+ | private void injected(CallbackInfo ci) { | ||
+ | doSomething3(); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Result: | ||
+ | <code diff> | ||
+ | public void foo() { | ||
+ | doSomething1(); | ||
+ | Something something = new Something(); | ||
+ | something.doSomething(); | ||
+ | doSomething2(); | ||
+ | + | ||
} | } | ||
</ | </ | ||
Line 194: | Line 244: | ||
doSomething3(); | doSomething3(); | ||
return 10; | return 10; | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Capturing local values ===== | ||
+ | |||
+ | Mixin: | ||
+ | <code java> | ||
+ | @Inject(method = " | ||
+ | private void injected(CallbackInfo ci, TypeArg1 arg1) { | ||
+ | // | ||
+ | arg1.doSomething4(); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Result: | ||
+ | <code diff> | ||
+ | public void foo() { | ||
+ | TypeArg1 arg1 = getArg1(); | ||
+ | arg1.doSomething1(); | ||
+ | arg1.doSomething2(); | ||
+ | TypeArg2 arg2 = getArg2(); | ||
+ | arg2.doSomething3(); | ||
+ | + | ||
} | } | ||
</ | </ |
tutorial/mixin_examples.txt · Last modified: 2024/01/13 15:02 by arkosammy12