Class ClientChatReceivedEvent.System

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.ClientChatReceivedEvent
net.neoforged.neoforge.client.event.ClientChatReceivedEvent.System
All Implemented Interfaces:
net.neoforged.bus.api.ICancellableEvent
Enclosing class:
ClientChatReceivedEvent

public static class ClientChatReceivedEvent.System extends ClientChatReceivedEvent
Fired when a system chat message is received on the client.

This event is cancellable, and does not

invalid reference
have a result
. If the event is cancelled, the message is not displayed in the chat message window or in the overlay.

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

  • Field Details

    • overlay

      private final boolean overlay
  • Constructor Details

    • System

      @Internal public System(Component message, boolean overlay)
  • Method Details

    • isOverlay

      public boolean isOverlay()
      Returns whether the message goes to the overlay.
      Returns:
      whether the message goes to the overlay