Interface IMessageable

All Known Subinterfaces:

ICommandSender, IPlayer, IServer

All Known Implementing Classes:

SpigotServer, WrappedOfflinePlayer, WrappedPlayer

public interface IMessageable

Represents objects that can receive messages.

Method Summary

Modifier and Type	Method	Description
PersonalizedLocalizer	getPersonalizedLocalizer()	Creates a new PersonalizedLocalizer using the localizer and locale of this messageable.
ITextFactory	getTextFactory()	Gets the text factory of this messageable.
default Text	newText()	Creates a new Text using the text factory of this messageable.
default void	sendError(String key, Text.ArgumentCreator... args)	Sends an error message to this messageable.
default void	sendInfo(String key, Text.ArgumentCreator... args)	Sends a info message to this object.
void	sendMessage(Text text)	Sends a message to this object.
default void	sendMessage(TextType textType, String key, Text.ArgumentCreator... args)	Sends a message to this object.
default void	sendSuccess(String key, Text.ArgumentCreator... args)	Sends a success message to this object.

Method Details

sendMessage

void sendMessage(Text text)

Sends a message to this object.

Parameters:

text - The message to send. This may or may not contain formatting.

getTextFactory

ITextFactory getTextFactory()

Gets the text factory of this messageable.

Returns:

The text factory of this messageable.

getPersonalizedLocalizer

PersonalizedLocalizer getPersonalizedLocalizer()

Creates a new PersonalizedLocalizer using the localizer and locale of this messageable.

Returns:

A new PersonalizedLocalizer object.

newText

default Text newText()

Creates a new Text using the text factory of this messageable.

Returns:

A new Text object.

sendMessage

default void sendMessage(TextType textType,
 String key,
 Text.ArgumentCreator... args)

Sends a message to this object.

This is a shortcut for sendMessage(Text).

Parameters:

textType - The TextType to use for the message to send.

key - The key of the error message. E.g. constants.error.generic.

args - The arguments to use for the message.

sendError

default void sendError(String key,
 Text.ArgumentCreator... args)

Sends an error message to this messageable.

This is a shortcut for sendMessage(TextType, String, Text.ArgumentCreator...) with the TextType.ERROR type.

Parameters:

key - The key of the error message. E.g. constants.error.generic.

args - The arguments to use for the message, if any.

sendSuccess

default void sendSuccess(String key,
 Text.ArgumentCreator... args)

Sends a success message to this object.

This is a shortcut for sendMessage(TextType, String, Text.ArgumentCreator...) with the TextType.SUCCESS type.

Parameters:

key - The key of the error message. E.g. constants.error.generic.

args - The arguments to use for the message, if any.

sendInfo

default void sendInfo(String key,
 Text.ArgumentCreator... args)

Sends a info message to this object.

This is a shortcut for sendMessage(TextType, String, Text.ArgumentCreator...) with the TextType.INFO type.

Parameters:

key - The key of the error message. E.g. constants.error.generic.

args - The arguments to use for the message, if any.