com.codelanx.codelanxlib.config

Interface Lang

All Superinterfaces:

com.codelanx.commons.config.InfoFile, com.codelanx.commons.config.LangFile

All Known Implementing Classes:

DefaultLang, InternalLang

public interface Lang
extends com.codelanx.commons.config.LangFile

Created by Rogue on 11/6/2015.

Field Summary

Fields

Modifier and Type	Field and Description
static com.codelanx.commons.config.LangFile	DEFAULT_DYNAMIC

Method Summary

Modifier and Type	Method and Description
static String	color(String color) Automatically translates strings that contain color codes using the '&' symbol
static Lang	createLang(String format) Returns a raw Lang object that can be used for dynamic creation of Lang variables
static Lang	defaultFormat(String option) Returns a Lang object representing the default formatting for all CodelanxLib plugins.
default String	formatAndColor(Object... args) Formats a LangFile enum constant with the supplied arguments, and colors it
default File	getFileLocation()
Lang	getFormat() Returns the format specifier for this LangFile file.
static Lang	getFormat(Plugin plugin) Returns an acceptable message format for the plugin at hand
static void	sendMessage(CommandSender target, Lang format, com.codelanx.commons.config.LangFile message, Object... args) Sends a message but does not include getFormat(org.bukkit.plugin.Plugin), instead it uses a supplied format
static void	sendMessage(CommandSender target, Lang message, Object... args) Sends a formatted string and prepends the getFormat(org.bukkit.plugin.Plugin) to it.
static void	sendMessage(OfflinePlayer target, Lang format, com.codelanx.commons.config.LangFile message, Object... args)
static void	sendMessage(OfflinePlayer target, Lang message, Object... args)
static void	sendMessage(Player target, Lang format, com.codelanx.commons.config.LangFile message, Object... args)
static void	sendMessage(Player target, Lang message, Object... args)
static void	sendRawMessage(CommandSender target, Lang message, Object... args) Sends a raw message without additional formatting aside from translating color codes
static void	sendRawMessage(OfflinePlayer target, Lang message, Object... args)
static void	sendRawMessage(Player target, Lang message, Object... args)
static void	sendTitle(Player target, com.codelanx.commons.config.LangFile message, Object... args) Issues a "title" command to a Player target with the passed Lang
static void	tellRaw(Player target, com.codelanx.commons.config.LangFile message, Object... args) Issues a "tellRaw" to a Player target with the supplied Lang

Methods inherited from interface com.codelanx.commons.config.LangFile

format, get, getDefault, pluralFormat, proper, proper

Methods inherited from interface com.codelanx.commons.config.InfoFile

getConfig, getData, getPath, init, save, save

Field Detail

DEFAULT_DYNAMIC

static final com.codelanx.commons.config.LangFile DEFAULT_DYNAMIC

Method Detail

getFormat

static Lang getFormat(Plugin plugin)

Returns an acceptable message format for the plugin at hand

Parameters:

plugin - A Plugin that needs a format

Returns:

A relevant LangFile format

Since:

0.1.0

getFormat

Lang getFormat()

Returns the format specifier for this LangFile file. This should be a constant in the enum and represent a value that is used for all messages universally.

Returns:

The format specifier for this LangFile

Since:

0.1.0

defaultFormat

static Lang defaultFormat(String option)

Returns a Lang object representing the default formatting for all CodelanxLib plugins. The option parameter can be supplemented with null which will default to "CL-Lib". The returned format is:

"&f[&9" + option == null ? "CL-Lib" : option + "&f] %amp;s"

Parameters:

option - The optional "title" string for the format

Returns:

A LangFile object representing the default format

Since:

0.1.0

color

static String color(String color)

Automatically translates strings that contain color codes using the '&' symbol

Parameters:

color - String with un-converted color codes

Returns:

string with correct chat colors included

Since:

0.1.0

sendMessage

static void sendMessage(CommandSender target,
                        Lang message,
                        Object... args)

Sends a formatted string and prepends the getFormat(org.bukkit.plugin.Plugin) to it.

Parameters:

target - The target to send to

message - The message to colorize and send

args - Arguments to supply to the LangFile message

Since:

0.1.0

sendMessage

static void sendMessage(CommandSender target,
                        Lang format,
                        com.codelanx.commons.config.LangFile message,
                        Object... args)

Sends a message but does not include getFormat(org.bukkit.plugin.Plugin), instead it uses a supplied format

Parameters:

target - The target to send to

format - The format provided

message - The message to colorize and send

args - Arguments to supply to the LangFile message

Since:

0.1.0

sendRawMessage

static void sendRawMessage(CommandSender target,
                           Lang message,
                           Object... args)

Sends a raw message without additional formatting aside from translating color codes

Parameters:

target - The target to send to

message - The message to colorize and send

args - Arguments to supply to the LangFile message

Since:

0.1.0

tellRaw

static void tellRaw(Player target,
                    com.codelanx.commons.config.LangFile message,
                    Object... args)

Issues a "tellRaw" to a Player target with the supplied Lang

Parameters:

target - The Player to send the JSON message to

message - A LangFile representing a JSON payload

args - The arguments for the passed LangFile

Since:

0.1.0

sendTitle

static void sendTitle(Player target,
                      com.codelanx.commons.config.LangFile message,
                      Object... args)

Issues a "title" command to a Player target with the passed Lang

Parameters:

target - The Player to send the JSON title to

message - A LangFile representing a JSON payload for the title

args - The arguments for the passed LangFile

Since:

0.1.0

formatAndColor

default String formatAndColor(Object... args)

Formats a LangFile enum constant with the supplied arguments, and colors it

Parameters:

args - The arguments to supply

Returns:

The formatted string

Since:

0.1.0

createLang

static Lang createLang(String format)

Returns a raw Lang object that can be used for dynamic creation of Lang variables

Specified by:

createLang in interface com.codelanx.commons.config.LangFile

Parameters:

format - The string to wrap in a LangFile object

Returns:

A LangFile object that will

Since:

0.1.0

sendMessage

static void sendMessage(OfflinePlayer target,
                        Lang format,
                        com.codelanx.commons.config.LangFile message,
                        Object... args)

sendMessage

static void sendMessage(OfflinePlayer target,
                        Lang message,
                        Object... args)

sendRawMessage

static void sendRawMessage(OfflinePlayer target,
                           Lang message,
                           Object... args)

sendMessage

static void sendMessage(Player target,
                        Lang format,
                        com.codelanx.commons.config.LangFile message,
                        Object... args)

sendMessage

static void sendMessage(Player target,
                        Lang message,
                        Object... args)

sendRawMessage

static void sendRawMessage(Player target,
                           Lang message,
                           Object... args)

getFileLocation

default File getFileLocation()

Specified by:

getFileLocation in interface com.codelanx.commons.config.InfoFile