Interface RitualTrigger<T>

Type Parameters:
T - The object considered the context of the trigger.
public interface RitualTrigger<T>
Represents a ritual trigger. The triggers are to be called from code, and may have trigger-specific conditions.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<RitualTrigger<?>>
    CODEC
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default net.minecraft.world.phys.Vec3
    adjustPosition(@Nullable net.minecraft.world.entity.player.Player player, net.minecraft.world.level.Level level, net.minecraft.world.phys.Vec3 vec, T context)
    Adjusts the position of the ritual checks.
    com.mojang.serialization.MapCodec<? extends RitualTrigger<T>>
    codec()
     
    default void
    consume(@Nullable net.minecraft.world.entity.player.Player player, net.minecraft.world.level.Level level, net.minecraft.world.phys.Vec3 vec, T context)
    Consumes the trigger, if applicable and the ritual was successful.
    boolean
    test(@Nullable net.minecraft.world.entity.player.Player player, net.minecraft.world.level.Level level, net.minecraft.world.phys.Vec3 vec, T context)
     

  • Field Details

    • CODEC

      static final com.mojang.serialization.Codec<RitualTrigger<?>> CODEC

  • Method Details

    • codec

      com.mojang.serialization.MapCodec<? extends RitualTrigger<T>> codec()
      Returns:
      The registered MapCodec.

    • test

      boolean test(@Nullable net.minecraft.world.entity.player.Player player, net.minecraft.world.level.Level level, net.minecraft.world.phys.Vec3 vec, T context)
      Parameters:
      player - The Player triggering the ritual.
      level - The Level the ritual is triggered in.
      vec - The Vec3 the ritual is triggered at.
      context - The context object.
      Returns:
      Whether the requirement should actually be triggered or not.

    • consume

      default void consume(@Nullable net.minecraft.world.entity.player.Player player, net.minecraft.world.level.Level level, net.minecraft.world.phys.Vec3 vec, T context)
      Consumes the trigger, if applicable and the ritual was successful. For example, the dropped item tick ritual trigger consumes the dropped items here.
      Parameters:
      player - The Player triggering the ritual.
      level - The Level the ritual is triggered in.
      vec - The Vec3 the ritual is triggered at.
      context - The context object.

    • adjustPosition

      default net.minecraft.world.phys.Vec3 adjustPosition(@Nullable net.minecraft.world.entity.player.Player player, net.minecraft.world.level.Level level, net.minecraft.world.phys.Vec3 vec, T context)

      Adjusts the position of the ritual checks. For example, the set block ritual trigger uses this to apply a position offset.

      This runs after test(Player, Level, Vec3, Object) and before all other ritual methods, including consume(Player, Level, Vec3, Object).

      Parameters:
      player - The Player triggering the ritual.
      level - The Level the ritual is triggered in.
      vec - The Vec3 the ritual is triggered at.
      context - The context object.
      Returns:
      The adjusted ritual position.