Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:mixin_tips

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Last revisionBoth sides next revision
tutorial:mixin_tips [2023/08/18 09:19] – Removed apostrophe treeway7tutorial:mixin_tips [2023/12/18 01:54] – solidblock
Line 5: Line 5:
 This is a collection of different tips some might find useful. It's recommended to read the previous articles to understand the tips. This is a collection of different tips some might find useful. It's recommended to read the previous articles to understand the tips.
  
-==== Why make a class abstract? ====+===== Why make a class abstract? =====
  
-**1. Prevent instantiation**+==== 1. Prevent instantiation ====
  
 It's fair to say that you should never instantiate a mixin class, mainly because the class doesn't make sense to java if it isn't used in a mixin environment, and there are other ways to access methods declared in a mixin. It's fair to say that you should never instantiate a mixin class, mainly because the class doesn't make sense to java if it isn't used in a mixin environment, and there are other ways to access methods declared in a mixin.
Line 18: Line 18:
  
  
-**2. Make more elegant shadow methods**+==== 2. Make more elegant shadow methods ====
  
 If you want to access a unaccessible method or field from your target class into your mixin class, you need to use ''@Shadow'' to make that method/field visible. If you want to access a unaccessible method or field from your target class into your mixin class, you need to use ''@Shadow'' to make that method/field visible.
Line 37: Line 37:
 Note: this doesn't work with private methods, since you can't have private abstract methods, and hence you need to use the normal one. Note: this doesn't work with private methods, since you can't have private abstract methods, and hence you need to use the normal one.
  
- +==== 3. Access the ''this'' instance more easily ====
-**3. Access the ''this'' instance more easily**+
  
 In mixin, if you want to access the "this" instance, you have to do a cast inside your mixin class: In mixin, if you want to access the "this" instance, you have to do a cast inside your mixin class:
Line 50: Line 49:
 Luckily, this can all be avoided by using an abstract class, in which case you don't have to implement methods and all problems are avoided. Luckily, this can all be avoided by using an abstract class, in which case you don't have to implement methods and all problems are avoided.
  
 +===== How to mixin inner classes =====
  
-==== How to mixin inner classes ==== +==== 1. Normal inaccessible inner classes ====
- +
-**1. Normal inaccessible inner classes **+
  
 Since this you can't directly access (and hence mention) these classes from outside, you need to use the "targets" field of the mixin annotation to specify the name. Since this you can't directly access (and hence mention) these classes from outside, you need to use the "targets" field of the mixin annotation to specify the name.
Line 76: Line 74:
 @Mixin(targets = "some.random.package.Outer$Inner") @Mixin(targets = "some.random.package.Outer$Inner")
 public class MyMixin { public class MyMixin {
-    @Inject(method = "someRandomMethod()V", at = @At("HEAD")+    @Inject(method = "someRandomMethod()V", at = @At("HEAD"))
     private void injected(CallbackInfo ci) {     private void injected(CallbackInfo ci) {
         // your code here         // your code here
Line 86: Line 84:
  
 <code java> <code java>
-@Inject(method = "<init>(Lsome/random/package/Outer;)V", at = @At("HEAD")+@Inject(method = "<init>(Lsome/random/package/Outer;)V", at = @At("HEAD"))
 private void injected(CallbackInfo ci) { private void injected(CallbackInfo ci) {
     // your code here     // your code here
Line 93: Line 91:
  
  
-**2. Static inaccessible inner classes**+==== 2. Static inaccessible inner classes ====
  
 These are the same as above, the only difference is that the constructor doesn't have the outer class first parameter (because in static inner classes only private static methods can be accessed from the inner class, and hence that parameter isn't needed). These are the same as above, the only difference is that the constructor doesn't have the outer class first parameter (because in static inner classes only private static methods can be accessed from the inner class, and hence that parameter isn't needed).
  
  
-**3. Anonymous inner classes**+==== 3. Anonymous inner classes ====
  
 These are the same as the static inaccessible inner classes, the only difference is that since they don't have a name, they are declared by appearance order, for example: the anonymous inner class if declared in our previous example class first would be named Outer$1, a second one would be named Outer$2, a third one Outer$3 and so on (the declaration order is on source level). These are the same as the static inaccessible inner classes, the only difference is that since they don't have a name, they are declared by appearance order, for example: the anonymous inner class if declared in our previous example class first would be named Outer$1, a second one would be named Outer$2, a third one Outer$3 and so on (the declaration order is on source level).
tutorial/mixin_tips.txt · Last modified: 2023/12/18 02:06 by solidblock