com.lirtistasya.plugins.regionmanager

Class RegionManagerCommandsManager.MessageProperties

java.lang.Object

com.lirtistasya.plugins.regionmanager.RegionManagerCommandsManager.MessageProperties

Enclosing class:

RegionManagerCommandsManager

public static class RegionManagerCommandsManager.MessageProperties
extends java.lang.Object

RegionManagerCommandsManager.MessageProperties contains all message-related stuff for RegionManager

Since:

1.2.0

Author:

lirtistasya/mezzodrinker

Field Summary

Fields

Modifier and Type	Field and Description
static org.bukkit.ChatColor	CHATCOLOR_BROADCAST public static final ChatColor CHATCOLOR_BROADCAST = ChatColor.DARK_AQUA; The color used when sending broadcasts.
static org.bukkit.ChatColor	CHATCOLOR_CMD public static final ChatColor CHATCOLOR_CMD = ChatColor.GOLD The color used to highlight a command.
static org.bukkit.ChatColor	CHATCOLOR_CMDDESC public static final ChatColor CHATCOLOR_CMDDESC = ChatColor.WHITE; The color used to highlight a command's description.
static org.bukkit.ChatColor	CHATCOLOR_CMDPARAM public static final ChatColor CHATCOLOR_CMDPARAM = ChatColor.GRAY; The color used to highlight a command's parameter.
static org.bukkit.ChatColor	CHATCOLOR_ERROR public static final ChatColor CHATCOLOR_ERROR = ChatColor.RED; The color used when sending error messages.
static org.bukkit.ChatColor	CHATCOLOR_PARAM public static final ChatColor CHATCOLOR_PARAM = ChatColor.WHITE; The color used to highlight a parameter.
static org.bukkit.ChatColor	CHATCOLOR_PLAYERMSG public static final ChatColor CHATCOLOR_PLAYERMSG = ChatColor.YELLOW; The color used when sending messages to a player.
static java.lang.String	MESSAGE_PREFIX public static final String MESSAGE_PREFIX = ChatColor.GRAY + "[" + ChatColor.DARK_AQUA + "RegionManager" + ChatColor.GRAY + "] "; The message prefix shown when sending a message.

Constructor Summary

Constructors

Constructor and Description
RegionManagerCommandsManager.MessageProperties()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getCantAfford(java.lang.String regionname, double price) Returns a "You can't afford"-message.
static java.lang.String	getCommandHelp(java.lang.String command, java.lang.String params, java.lang.String desc) Returns a command's help message.
static java.lang.String	getFooter() Returns the footer used by RegionManager when sending longer messages.
static java.lang.String	getHeader(java.lang.String title) Returns a header with a specified title.
static java.lang.String	getNoEconomy() Returns an error message that an economy plugin was not found.
static java.lang.String	getNoPermission(java.lang.String permission) Returns an error message for insufficient permissions.
static java.lang.String	getRegionInfo(org.bukkit.configuration.file.YamlConfiguration config, org.bukkit.configuration.file.YamlConfiguration regions, java.lang.String regionname) Returns a description of a region.
static java.lang.String	getRegionList(java.lang.String player, java.util.Map<java.lang.String,java.lang.String> regions) Returns a region list for a certain player.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_PREFIX

public static final java.lang.String MESSAGE_PREFIX

public static final String MESSAGE_PREFIX = ChatColor.GRAY + "[" + ChatColor.DARK_AQUA + "RegionManager" + ChatColor.GRAY + "] ";

The message prefix shown when sending a message.

CHATCOLOR_BROADCAST

public static final org.bukkit.ChatColor CHATCOLOR_BROADCAST

public static final ChatColor CHATCOLOR_BROADCAST = ChatColor.DARK_AQUA;

The color used when sending broadcasts.

CHATCOLOR_PLAYERMSG

public static final org.bukkit.ChatColor CHATCOLOR_PLAYERMSG

public static final ChatColor CHATCOLOR_PLAYERMSG = ChatColor.YELLOW;

The color used when sending messages to a player.

CHATCOLOR_PARAM

public static final org.bukkit.ChatColor CHATCOLOR_PARAM

public static final ChatColor CHATCOLOR_PARAM = ChatColor.WHITE;

The color used to highlight a parameter.

CHATCOLOR_CMD

public static final org.bukkit.ChatColor CHATCOLOR_CMD

public static final ChatColor CHATCOLOR_CMD = ChatColor.GOLD

The color used to highlight a command.

CHATCOLOR_CMDPARAM

public static final org.bukkit.ChatColor CHATCOLOR_CMDPARAM

public static final ChatColor CHATCOLOR_CMDPARAM = ChatColor.GRAY;

The color used to highlight a command's parameter.

CHATCOLOR_CMDDESC

public static final org.bukkit.ChatColor CHATCOLOR_CMDDESC

public static final ChatColor CHATCOLOR_CMDDESC = ChatColor.WHITE;

The color used to highlight a command's description.

CHATCOLOR_ERROR

public static final org.bukkit.ChatColor CHATCOLOR_ERROR

public static final ChatColor CHATCOLOR_ERROR = ChatColor.RED;

The color used when sending error messages.

Constructor Detail

RegionManagerCommandsManager.MessageProperties

public RegionManagerCommandsManager.MessageProperties()

Method Detail

getCantAfford

public static final java.lang.String getCantAfford(java.lang.String regionname,
                             double price)

Returns a "You can't afford"-message.

Parameters:

regionname - the region's name that can't be afforded

price - the price of that region

Returns:

the message

getCommandHelp

public static final java.lang.String getCommandHelp(java.lang.String command,
                              java.lang.String params,
                              java.lang.String desc)

Returns a command's help message.

Parameters:

command - the command

params - the command's parameters

desc - the command's description

Returns:

the help message

getFooter

public static final java.lang.String getFooter()

Returns the footer used by RegionManager when sending longer messages.

Returns:

CHATCOLOR_CMD + " ===== ### ===== "

See Also:

CHATCOLOR_CMD

getHeader

public static final java.lang.String getHeader(java.lang.String title)

Returns a header with a specified title. If the title is null, a RegionManager header will be returned.

Parameters:

title - the title

Returns:

the header

getNoEconomy

public static final java.lang.String getNoEconomy()

Returns an error message that an economy plugin was not found.

Returns:

the error message

getNoPermission

public static final java.lang.String getNoPermission(java.lang.String permission)

Returns an error message for insufficient permissions.

Parameters:

permission - the missing permission

Returns:

the error message

getRegionInfo

public static final java.lang.String getRegionInfo(org.bukkit.configuration.file.YamlConfiguration config,
                             org.bukkit.configuration.file.YamlConfiguration regions,
                             java.lang.String regionname)

Returns a description of a region.

Parameters:

config - the RegionManager configuration

regions - the RegionManager regions file

regionname - the region's name

Returns:

the description

getRegionList

public static final java.lang.String getRegionList(java.lang.String player,
                             java.util.Map<java.lang.String,java.lang.String> regions)

Returns a region list for a certain player. If null is used instead of a player's name this method will replace the player's name with "your".

Parameters:

player - the player's name or null

regions - the player's regions where the value is the status (owner/member) of that player.

Returns:

the region list