Package dev.architectury.event

Class EventResult

java.lang.Object
dev.architectury.event.EventResult
public final class EventResult extends Object
A result from an event, determines if the event should continue to other listeners, and determines the outcome of the event.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    net.minecraft.world.InteractionResult
    asMinecraft()
    Returns the Minecraft-facing result, however ignores interruptsFurtherEvaluation().
    static EventResult
    interrupt(Boolean value)
    Interrupts the event and stops it from being passed on to other listeners, may or may not set an outcome of the event.
    static EventResult
    interruptDefault()
    Interrupts the event and stops it from being passed on to other listeners, and does not set an outcome.
    static EventResult
    interruptFalse()
    Interrupts the event and stops it from being passed on to other listeners, and denotes the false outcome.
    boolean
    interruptsFurtherEvaluation()
    Returns whether this result interrupts the evaluation of other listeners.
    static EventResult
    interruptTrue()
    Interrupts the event and stops it from being passed on to other listeners, and denotes the true outcome.
    boolean
    isEmpty()
    Returns whether the result does not contain an outcome, may be false only if the event is deterministic.
    boolean
    isFalse()
    Returns whether the result contains a false outcome
    boolean
    isPresent()
    Returns whether the result contains an outcome, may be true only if the event is deterministic.
    boolean
    isTrue()
    Returns whether the result contains a true outcome
    static EventResult
    pass()
    Passes the event to other listeners, and does not set an outcome of the event.
    Boolean
    value()
    Returns the outcome of the result, an passing result will never have an outcome.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • pass

      public static EventResult pass()
      Passes the event to other listeners, and does not set an outcome of the event.
      Returns:
      an event that passes the event to other listeners

    • interrupt

      public static EventResult interrupt(Boolean value)
      Interrupts the event and stops it from being passed on to other listeners, may or may not set an outcome of the event.
      Parameters:
      value - the outcome of the event, passing null here means the default outcome, which often means falling back to vanilla logic
      Returns:
      an event that interrupts the event

    • interruptTrue

      public static EventResult interruptTrue()
      Interrupts the event and stops it from being passed on to other listeners, and denotes the true outcome.
      Returns:
      an event that interrupts the event

    • interruptDefault

      public static EventResult interruptDefault()
      Interrupts the event and stops it from being passed on to other listeners, and does not set an outcome.
      Returns:
      an event that interrupts the event

    • interruptFalse

      public static EventResult interruptFalse()
      Interrupts the event and stops it from being passed on to other listeners, and denotes the false outcome.
      Returns:
      an event that interrupts the event

    • interruptsFurtherEvaluation

      public boolean interruptsFurtherEvaluation()
      Returns whether this result interrupts the evaluation of other listeners.
      Returns:
      whether this result interrupts the evaluation of other listeners

    • value

      public Boolean value()
      Returns the outcome of the result, an passing result will never have an outcome.
      Returns:
      the outcome of the result, returns null if fallback

    • isEmpty

      public boolean isEmpty()
      Returns whether the result does not contain an outcome, may be false only if the event is deterministic.
      Returns:
      whether the result does not contain an outcome

    • isPresent

      public boolean isPresent()
      Returns whether the result contains an outcome, may be true only if the event is deterministic.
      Returns:
      whether the result contains an outcome

    • isTrue

      public boolean isTrue()
      Returns whether the result contains a true outcome
      Returns:
      whether the result contains a true outcome

    • isFalse

      public boolean isFalse()
      Returns whether the result contains a false outcome
      Returns:
      whether the result contains a false outcome

    • asMinecraft

      public net.minecraft.world.InteractionResult asMinecraft()
      Returns the Minecraft-facing result, however ignores interruptsFurtherEvaluation().
      Returns:
      the Minecraft-facing result