org.spongepowered.api.event.message

Interface MessageEvent

All Superinterfaces:

Event

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractMessageEvent

public interface MessageEvent
extends Event

Describes events when a involving a Text message.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessageEvent.DefaultBodyApplier Represents the initial body set by the implementation before the event is posted.
static class	MessageEvent.DefaultHeaderApplier Represents the initial header set by the implementation before the event is posted.
static class	MessageEvent.MessageFormatter Formatter used for formatting messages within this event.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_MESSAGE_BODY Parameter for body section in body partition.
static String	PARAM_MESSAGE_FOOTER Parameter for footer section in footer partition.
static String	PARAM_MESSAGE_HEADER Parameter for header section in header partition.

Method Summary

Modifier and Type	Method and Description
default MessageEvent.MessageFormatter	clearMessage() Clears the currently set message and returns the empty formatter.
MessageEvent.MessageFormatter	getFormatter() Returns the MessageEvent.MessageFormatter used to mutate the event's message.
default Text	getMessage() Returns the formatted message.
Text	getOriginalMessage() Gets the original Text message.
boolean	isMessageCancelled() Returns true if the Text returned by getMessage() should not be sent.
default void	setMessage(TextRepresentable body) Clears any existing components and sets the body.
default void	setMessage(TextRepresentable header, TextRepresentable body) Clears any existing components and sets the header and body respectively.
default void	setMessage(TextRepresentable header, TextRepresentable body, TextRepresentable footer) Clears any existing components and sets the header, body, and footer respectively.
void	setMessageCancelled(boolean cancelled) Sets whether the Text returned by getMessage() should be sent.

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

getCause, getContext, getSource

Field Detail

PARAM_MESSAGE_HEADER

static final String PARAM_MESSAGE_HEADER

Parameter for header section in header partition.

See Also:

Constant Field Values

PARAM_MESSAGE_BODY

static final String PARAM_MESSAGE_BODY

Parameter for body section in body partition.

See Also:

Constant Field Values

PARAM_MESSAGE_FOOTER

static final String PARAM_MESSAGE_FOOTER

Parameter for footer section in footer partition.

See Also:

Constant Field Values

Method Detail

getOriginalMessage

Text getOriginalMessage()

Gets the original Text message.

Returns:

The message

isMessageCancelled

boolean isMessageCancelled()

Returns true if the Text returned by getMessage() should not be sent.

Returns:

True if message should not be sent

setMessageCancelled

void setMessageCancelled(boolean cancelled)

Sets whether the Text returned by getMessage() should be sent.

Parameters:

cancelled - True if should not be sent

getFormatter

MessageEvent.MessageFormatter getFormatter()

Returns the MessageEvent.MessageFormatter used to mutate the event's message.

Returns:

MessageFormatter of event

getMessage

default Text getMessage()

Returns the formatted message.

Returns:

Message

clearMessage

default MessageEvent.MessageFormatter clearMessage()

Clears the currently set message and returns the empty formatter.

Returns:

Empty MessageEvent.MessageFormatter

setMessage

default void setMessage(TextRepresentable header,
                        TextRepresentable body,
                        TextRepresentable footer)

Clears any existing components and sets the header, body, and footer respectively.

Parameters:

header - Header value

body - Body value

footer - Footer value

setMessage

default void setMessage(TextRepresentable header,
                        TextRepresentable body)

Clears any existing components and sets the header and body respectively.

Parameters:

header - Header value

body - Body value

setMessage

default void setMessage(TextRepresentable body)

Clears any existing components and sets the body.

Parameters:

body - Body value