Package me.shedaniel.architectury.event
Class EventResult
java.lang.Object
me.shedaniel.architectury.event.EventResult
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 TypeMethodDescriptionstatic EventResult
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
Interrupts the event and stops it from being passed on to other listeners, and does not set an outcome.static EventResult
Interrupts the event and stops it from being passed on to other listeners, and denotes thefalse
outcome.boolean
Returns whether this result interrupts the evaluation of other listeners.static EventResult
Interrupts the event and stops it from being passed on to other listeners, and denotes thetrue
outcome.static EventResult
pass()
Passes the event to other listeners, and does not set an outcome of the event.value()
Returns the outcome of the result, an passing result will never have an outcome.
-
Method Details
-
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
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, passingnull
here means the default outcome, which often means falling back to vanilla logic- Returns:
- an event that interrupts the event
-
interruptTrue
Interrupts the event and stops it from being passed on to other listeners, and denotes thetrue
outcome.- Returns:
- an event that interrupts the event
-
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
Interrupts the event and stops it from being passed on to other listeners, and denotes thefalse
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
Returns the outcome of the result, an passing result will never have an outcome.- Returns:
- the outcome of the result, returns
null
if fallback
-