Fabric Wiki

User Tools

Site Tools

Trace: • Interface Injection
tutorial:interface_injection

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:interface_injection [2025/11/27 23:17] – Rewrite to use class tweakers earthcomputertutorial:interface_injection [2025/12/27 12:27] (current) – gauntrecluse
Line 16: Line 16:
  
 <yarncode java [enable_line_numbers="false"]> <yarncode java [enable_line_numbers="false"]>
-Optional<class_3414> getBucketEmptySound$myMod()+Optional<class_3414> modid$getBucketEmptySound()
 </yarncode> </yarncode>
  
Line 27: Line 27:
  
 public interface BucketEmptySoundGetter { public interface BucketEmptySoundGetter {
- default Optional<class_3414> getBucketEmptySound$myMod() {+ default Optional<class_3414> modid$getBucketEmptySound() {
  return Optional.empty();  return Optional.empty();
  }  }
Line 33: Line 33:
 </yarncode> </yarncode>
  
-:!: The method body in the interface may not be used because it will be overridden by the mixin class. However, you must specify the method body, which means the method must be ''default''. You can make it return null or throw ''UnsupportedOperationException'', but you //cannot// make it abstract, such as ''Optional<yarn class_3414> getBucketEmptySound()'', or exceptions will be thrown when compiling!+:!: Even if the method body in the interface isn't supposed to be used because it will be overridden by the mixin class, you must still generally specify the method body, which means the method must be ''default''. You can make it return null or throw ''UnsupportedOperationException'', but you //cannot// make it abstract, such as ''Optional<yarn class_3414> modid$getBucketEmptySound()'', or exceptions will be thrown when compiling!
  
-ℹ️ It's highly recommended to add a dollar-character or underscore character with the mod name as the prefix or suffix of the method name, in order to avoid method name conflict with other mods.+ℹ️ If implementing the method with an interface, it's highly recommended to add a dollar-character or underscore character with the mod name as the prefix or suffix of the method name, in order to avoid method name conflict with other mods.
  
 ===== Step 2: Implement the Interface with a Mixin ===== ===== Step 2: Implement the Interface with a Mixin =====
  
-Now you need to implement this interface into ''<yarn net.minecraft.class_3609>'' with a mixin implementing the interface:+The class tweaker step below on its own will be enough if you only want to implement the interface (for example, for marker interfaces, or where you have the whole implementation in default methods). However, you need to implement this interface on a mixin to ''<yarn net.minecraft.class_3609>'' if you want to implement any methods without providing the implementation in a default method:
  
 <yarncode java [enable_line_numbers="false"]> <yarncode java [enable_line_numbers="false"]>
Line 45: Line 45:
 abstract class MixinFlowableFluid implements BucketEmptySoundGetter { abstract class MixinFlowableFluid implements BucketEmptySoundGetter {
  @Override  @Override
- public Optional<class_3414> getBucketEmptySound$myMod() {+ public Optional<class_3414> modid$getBucketEmptySound() {
      //This is how to get the default sound, copied from BucketItem class.      //This is how to get the default sound, copied from BucketItem class.
      return Optional.of(((class_3609) (Object) this).method_15791(class_3486.field_15518) ? class_3417.field_15010 : class_3417.field_14834);      return Optional.of(((class_3609) (Object) this).method_15791(class_3486.field_15518) ? class_3417.field_15010 : class_3417.field_14834);
Line 51: Line 51:
 } }
 </yarncode> </yarncode>
 +
  
 ===== Step 3: Inject the Interface in the class tweaker ===== ===== Step 3: Inject the Interface in the class tweaker =====
Line 59: Line 60:
 Note that all class names here must use the "internal names" that use slashes instead of dots (''path/to/my/Class''). Note that all class names here must use the "internal names" that use slashes instead of dots (''path/to/my/Class'').
  
-<yarncode none mymod.classtweaker [enable_line_numbers="false"]>+<code - mymod.classtweaker [enable_line_numbers="false"]>
 classTweaker v1 named classTweaker v1 named
  
-inject-interface net.minecraft.class_3609 net/fabricmc/example/BucketEmptySoundGetter +inject-interface net/minecraft/fluid/FlowableFluid net/fabricmc/example/BucketEmptySoundGetter 
-</yarncode>+</code>
  
-To make your interface injection visible to other mods depending on your mod (if you are writing a library mod), use ''transitive-inject-interface'' instead of ''inject-interface''.+:!: To make your interface injection visible to other mods depending on your mod (if you are writing a library mod), use ''transitive-inject-interface'' instead of ''inject-interface''.
  
 ==== Generic interfaces ==== ==== Generic interfaces ====
Line 82: Line 83:
  
 Here is a full example using generics: Here is a full example using generics:
-<yarncode none mymod.classtweaker [enable_line_numbers="false"]>+<code - mymod.classtweaker [enable_line_numbers="false"]>
 classTweaker v1 named classTweaker v1 named
  
-inject-interface net/minecraft/class_3609 net/fabricmc/example/MyGenericInterface<+TT;TU;> +inject-interface net/minecraft/fluid/FlowableFluid net/fabricmc/example/MyGenericInterface<+TT;TU;> 
-</yarncode>+</code>
 which would generate the implementation: which would generate the implementation:
 <yarncode java [enable_line_numbers="false"]> <yarncode java [enable_line_numbers="false"]>
Line 99: Line 100:
  
 <yarncode java [enable_line_numbers="false"]> <yarncode java [enable_line_numbers="false"]>
-Optional<class_3414> sound = mytestfluid.getBucketEmptySound$myMod();+Optional<class_3414> sound = mytestfluid.modid$getBucketEmptySound();
 </yarncode> </yarncode>
  
tutorial/interface_injection.1764285474.txt.gz · Last modified: 2025/11/27 23:17 by earthcomputer