me.mrCookieSlime.CSCoreLibPlugin.Configuration

Class Localization

java.lang.Object

me.mrCookieSlime.CSCoreLibPlugin.Configuration.Localization

public class Localization
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Localization(org.bukkit.plugin.Plugin plugin) Creates a new Localization Object for the specified Plugin

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getTranslation(java.lang.String key) Returns the Strings referring to the specified Key
void	reload() Reloads the messages.yml File
void	save() Saves this Localization to its File
void	sendTranslation(org.bukkit.command.CommandSender sender, java.lang.String key, boolean addPrefix, Variable... variables) Sends all Messages the key is referring to including the Prefix and specified Variables
void	setDefault(java.lang.String key, java.lang.String... messages) Sets the Default Message/s for the specified Key
void	setPrefix(java.lang.String prefix) Sets the default Message Prefix

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Localization

public Localization(org.bukkit.plugin.Plugin plugin)

Creates a new Localization Object for the specified Plugin

Parameters:

plugin - The Plugin this Localization is made for

Method Detail

setDefault

public void setDefault(java.lang.String key,
                       java.lang.String... messages)

Sets the Default Message/s for the specified Key

Parameters:

key - The Key of those Messages

messages - The Messages which this key will refer to by default

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the default Message Prefix

Parameters:

prefix - The Prefix by default

getTranslation

public java.util.List<java.lang.String> getTranslation(java.lang.String key)

Returns the Strings referring to the specified Key

Parameters:

key - The Key of those Messages

Returns:

The List this key is referring to

sendTranslation

public void sendTranslation(org.bukkit.command.CommandSender sender,
                            java.lang.String key,
                            boolean addPrefix,
                            Variable... variables)

Sends all Messages the key is referring to including the Prefix and specified Variables

Parameters:

sender - The Player/Console who should receive these Messages

key - The Key of those Messages

addPrefix - Specify whether the Prefix will get added or not

variables - All Variables which should be applied to the sent messages

reload

public void reload()

Reloads the messages.yml File

save

public void save()

Saves this Localization to its File