Package net.neoforged.neoforge.client.event

Class ToastAddEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.ToastAddEvent
All Implemented Interfaces:
net.neoforged.bus.api.ICancellableEvent
public class ToastAddEvent extends net.neoforged.bus.api.Event implements net.neoforged.bus.api.ICancellableEvent
Fired when the client queues a Toast message to be shown onscreen. Toasts are small popups that appear on the top right of the screen, for certain actions such as unlocking Advancements and Recipes.

This event is cancellable, and does not have a result. Cancelling the event stops the toast from being queued, which means it never renders.

This event is fired on the main Forge event bus, only on the logical client.

  • Nested Class Summary

    Nested classes/interfaces inherited from class net.neoforged.bus.api.Event

    net.neoforged.bus.api.Event.HasResult, net.neoforged.bus.api.Event.Result

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final Toast
    toast
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToastAddEvent(Toast toast)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Toast
    getToast()
     

    Methods inherited from class net.neoforged.bus.api.Event

    getResult, hasResult, setResult

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

    isCanceled, setCanceled

  • Field Details

    • toast

      private final Toast toast

  • Constructor Details

    • ToastAddEvent

      public ToastAddEvent(Toast toast)

  • Method Details

    • getToast

      public Toast getToast()