org.spongepowered.api.event.message

Interface MessageChannelEvent

All Superinterfaces:

Event, MessageEvent

All Known Subinterfaces:

AdvancementEvent.Grant, ClientConnectionEvent.Disconnect, ClientConnectionEvent.Join, DestructEntityEvent, DestructEntityEvent.Death, KickPlayerEvent, MessageChannelEvent.Chat

public interface MessageChannelEvent
extends MessageEvent

Describes events when a involving a Text message and MessageChannels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessageChannelEvent.Chat Fired when the Text being sent to a MessageChannel was due to chatting.

Nested classes/interfaces inherited from interface org.spongepowered.api.event.message.MessageEvent

MessageEvent.DefaultBodyApplier, MessageEvent.DefaultHeaderApplier, MessageEvent.MessageFormatter

Field Summary

Fields inherited from interface org.spongepowered.api.event.message.MessageEvent

PARAM_MESSAGE_BODY, PARAM_MESSAGE_FOOTER, PARAM_MESSAGE_HEADER

Method Summary

Modifier and Type	Method and Description
Optional<MessageChannel>	getChannel() Gets the current channel that this message will be sent to.
MessageChannel	getOriginalChannel() Gets the original channel that this message will be sent to.
void	setChannel(MessageChannel channel) Sets the channel for this message to go to.

Methods inherited from interface org.spongepowered.api.event.message.MessageEvent

clearMessage, getFormatter, getMessage, getOriginalMessage, isMessageCancelled, setMessage, setMessage, setMessage, setMessageCancelled

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

getOriginalChannel

MessageChannel getOriginalChannel()

Gets the original channel that this message will be sent to.

Returns:

The original message channel to send to

getChannel

Optional<MessageChannel> getChannel()

Gets the current channel that this message will be sent to.

Note that an Optional.empty() channel is different from a MessageChannel.TO_NONE channel.

Returns:

The message channel the message in this event will be sent to

setChannel

void setChannel(@Nullable
                MessageChannel channel)

Sets the channel for this message to go to.

Note that setting this to null, or no channel, is different from a MessageChannel.TO_NONE channel.

Parameters:

channel - The channel to set