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
Fired when a system chat message is received on the client.
This event is cancellable, and does not 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.
-
Nested Class Summary
Nested classes/interfaces inherited from class net.neoforged.neoforge.client.event.ClientChatReceivedEvent
ClientChatReceivedEvent.Player, ClientChatReceivedEvent.System
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether the message goes to the overlay.Methods inherited from class net.neoforged.neoforge.client.event.ClientChatReceivedEvent
getBoundChatType, getMessage, getSender, isSystem, setMessage
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
-
overlay
private final boolean overlay
-
-
Constructor Details
-
System
-
-
Method Details
-
isOverlay
public boolean isOverlay()Returns whether the message goes to the overlay.- Returns:
- whether the message goes to the overlay
-