com.bgsoftware.superiorskyblock.api.service.message

Interface MessagesService

public interface MessagesService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MessagesService.Builder Builder class for creating IMessageComponents

Method Summary

Modifier and Type	Method and Description
IMessageComponent	getComponent(java.lang.String message, java.util.Locale locale) Get a component of a built-in message of the plugin.
MessagesService.Builder	newBuilder() Create a new builder for message components.
IMessageComponent	parseComponent(org.bukkit.configuration.file.YamlConfiguration config, java.lang.String path) Parse a message from config file into a message component.

Method Detail

parseComponent

IMessageComponent parseComponent(org.bukkit.configuration.file.YamlConfiguration config,
                                 java.lang.String path)

Parse a message from config file into a message component.

Parameters:

config - The configuration file.

path - The path of the message.

Returns:

the parsed component message.

getComponent

@Nullable
IMessageComponent getComponent(java.lang.String message,
                                          java.util.Locale locale)

Get a component of a built-in message of the plugin.

Parameters:

message - The name of the message, similar to its name in the lang file of the plugin.

locale - The locale to retrieve the message for. For player's locale, use SuperiorPlayer.getUserLocale()

newBuilder

MessagesService.Builder newBuilder()

Create a new builder for message components.