Fabric Wiki

User Tools

Site Tools

Trace:
tutorial:mixin_accessors

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
Last revisionBoth sides next revision
tutorial:mixin_accessors [2020/08/28 08:14] – Fix minor error siglongtutorial:mixin_accessors [2021/04/01 17:30] – Make accessor example less icky proudmuslim
Line 1: Line 1:
 ====== Mixin Accessors ====== ====== Mixin Accessors ======
- 
-===== Introduction ===== 
 Mixin Accessors allow you to access fields and methods that are not visible (private) or final. Mixin Accessors allow you to access fields and methods that are not visible (private) or final.
  
-==== Accessor ==== +===== Accessor ===== 
-''@Accessor'' allows you to access fields.+''@Accessor'' allows you to access fields. Suppose we want to access ''itemUseCooldown'' field of ''MinecraftClient'' class.
  
-=== Get a value from a field ===+==== Getting a value from the field ====
 <code java> <code java>
 @Mixin(MinecraftClient.class) @Mixin(MinecraftClient.class)
 public interface MinecraftClientAccessor { public interface MinecraftClientAccessor {
-    @Accessor("itemUseCooldown") +    @Accessor 
-    public int getItemUseCooldown();+    int getItemUseCooldown();
 } }
 </code> </code>
Line 22: Line 20:
 </code> </code>
  
-=== Set a value to a field ===+==== Setting a value to the field ====
 <code java> <code java>
 @Mixin(MinecraftClient.class) @Mixin(MinecraftClient.class)
Line 37: Line 35:
 </code> </code>
  
-==== Provider ==== +===== Accessor for static fields ===== 
-''@Provider'' allows you to access methods.+Suppose we want to access ''BIOMES'' field of ''VanillaLayeredBiomeSource'' class. 
 + 
 +==== Getting a value from the field ==== 
 +<code java> 
 +@Mixin(VanillaLayeredBiomeSource.class) 
 +public interface VanillaLayeredBiomeSourceAccessor { 
 +  @Accessor("BIOMES") 
 +  public static List<RegistryKey<Biome>> getBiomes() { 
 +    throw new AssertionError(); 
 +  } 
 +} 
 +</code> 
 + 
 +Usage: 
 + 
 +<code java> 
 +List<RegistryKey<Biome>> biomes = VanillaLayeredBiomeSourceAccessor.getBiomes(); 
 +</code> 
 + 
 +==== Setting a value to the field ==== 
 +<code java> 
 +@Mixin(VanillaLayeredBiomeSource.class) 
 +public interface VanillaLayeredBiomeSourceAccessor { 
 +  @Accessor("BIOMES") 
 +  public static void setBiomes(List<RegistryKey<Biome>> biomes) { 
 +    throw new AssertionError(); 
 +  } 
 +} 
 +</code> 
 + 
 +Usage: 
 + 
 +<code java> 
 +VanillaLayeredBiomeSourceAccessor.setBiomes(biomes); 
 +</code> 
 + 
 +===== Invoker ===== 
 +''@Invoker'' allows you to access methods. Suppose we want to invoke ''teleportTo'' method of ''EndermanEntity'' class.
  
 <code java> <code java>
 @Mixin(EndermanEntity.class) @Mixin(EndermanEntity.class)
 public interface EndermanEntityInvoker { public interface EndermanEntityInvoker {
-  @Provider +  @Invoker("teleportTo") 
-  public boolean teleportTo(double x, double y, double z);+  public boolean invokeTeleportTo(double x, double y, double z);
 } }
 </code> </code>
Line 52: Line 87:
 <code java> <code java>
 EndermanEntity enderman = ...; EndermanEntity enderman = ...;
-((EndermanEntityInvoker) enderman).teleportTo(0.0D, 70.0D, 0.0D);+((EndermanEntityInvoker) enderman).invokeTeleportTo(0.0D, 70.0D, 0.0D);
 </code> </code>
  
 +===== Invoker for static methods =====
 +Suppose we want to invoke ''registerPotionType'' method of ''BrewingRecipeRegistry'' class.
 +
 +<code java>
 +@Mixin(BrewingRecipeRegistry.class)
 +public interface BrewingRecipeRegistryInvoker {
 +  @Invoker("registerPotionType")
 +  public static void invokeRegisterPotionType(Item item) {
 +    throw new AssertionError();
 +  }
 +}
 +</code>
 +
 +Usage:
 +
 +<code java>
 +BrewingRecipeRegistryInvoker.invokeRegisterPotionType(item);
 +</code>
tutorial/mixin_accessors.txt · Last modified: 2022/04/29 09:54 by solidblock