org.spongepowered.api.text.channel

Interface MessageReceiver

All Known Subinterfaces:

CommandBlock, CommandBlockMinecart, CommandBlockSource, CommandSource, ConsoleSource, Player, ProxySource, RconSource, RemoteSource, SignSource, World

public interface MessageReceiver

Represents something that can receive (and send) messages.

Method Summary

Modifier and Type	Method and Description
MessageChannel	getMessageChannel() Return the message channel that messages from this source should be sent to.
void	sendMessage(Text message) Sends a message to this receiver.
default void	sendMessage(TextTemplate template) Sends a message constructed from the TextTemplate to this receiver.
default void	sendMessage(TextTemplate template, Map<String,TextElement> parameters) Sends a message constructed from the TextTemplate and parameters to this receiver.
default void	sendMessages(Iterable<Text> messages) Sends the message(s) to this receiver.
default void	sendMessages(Text... messages) Sends the message(s) to this receiver.
void	setMessageChannel(MessageChannel channel) Sets the message channel that messages sent by this source should be sent to.

Method Detail

sendMessage

void sendMessage(Text message)

Sends a message to this receiver.

If text formatting is not supported in the implementation it will be displayed as plain text.

Parameters:

message - The message

sendMessage

default void sendMessage(TextTemplate template)

Sends a message constructed from the TextTemplate to this receiver.

If text formatting is not supported in the implementation it will be displayed as plain text.

Parameters:

template - The text template

sendMessage

default void sendMessage(TextTemplate template,
                         Map<String,TextElement> parameters)

Sends a message constructed from the TextTemplate and parameters to this receiver.

If text formatting is not supported in the implementation it will be displayed as plain text.

Parameters:

template - The text template

parameters - The parameters to apply to the template

sendMessages

default void sendMessages(Text... messages)

Sends the message(s) to this receiver.

If text formatting is not supported in the implementation it will be displayed as plain text.

Parameters:

messages - The message(s)

sendMessages

default void sendMessages(Iterable<Text> messages)

Sends the message(s) to this receiver.

If text formatting is not supported in the implementation it will be displayed as plain text.

Parameters:

messages - The messages

getMessageChannel

MessageChannel getMessageChannel()

Return the message channel that messages from this source should be sent to.

Returns:

This source's active message channel

setMessageChannel

void setMessageChannel(MessageChannel channel)

Sets the message channel that messages sent by this source should be sent to.

Parameters:

channel - The message channel to send messages to