Fabric Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Mixin Accessors & Invokers ======
Mixin accessors and invokers allow you to access fields or invoke methods that are not visible (private) or final.

===== Accessor =====
''@Accessor'' allows you to access fields. Suppose we want to access ''itemUseCooldown'' field of ''MinecraftClient'' class.

==== Getting a value from the field ====
<code java>
@Mixin(MinecraftClient.class)
public interface MinecraftClientAccessor {
    @Accessor
    int getItemUseCooldown();
}
</code>

Usage:

<code java>
int itemUseCooldown = ((MinecraftClientAccessor) MinecraftClient.getInstance()).getItemUseCooldown();
</code>

==== Setting a value to the field ====
<code java>
@Mixin(MinecraftClient.class)
public interface MinecraftClientAccessor {
    @Accessor("itemUseCooldown")
    public void setItemUseCooldown(int itemUseCooldown);
}
</code>

Usage:

<code java>
((MinecraftClientAccessor) MinecraftClient.getInstance()).setItemUseCooldown(100);
</code>

When the field is final and you need to set it, use ''@Mutable'' as well. Note that this may not work as expected if the field is set to a constant literal value in its initializer, such as ''42'' or ''"Hello World"''. This is because ''javac'' inlines constant fields.

===== Accessor for static fields =====
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>

When the field is final and you need to set it, use ''@Mutable'' as well. Note that this may not work as expected if the field is set to a constant literal value in its initializer, such as ''42'' or ''"Hello World"''. This is because ''javac'' inlines constant fields.

===== Invoker =====
''@Invoker'' allows you to access methods. Suppose we want to invoke ''teleportTo'' method of ''EndermanEntity'' class.

<code java>
@Mixin(EndermanEntity.class)
public interface EndermanEntityInvoker {
  @Invoker("teleportTo")
  public boolean invokeTeleportTo(double x, double y, double z);
}
</code>

Usage:

<code java>
EndermanEntity enderman = ...;
((EndermanEntityInvoker) enderman).invokeTeleportTo(0.0D, 70.0D, 0.0D);
</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>