com.lirtistasya.plugins.regionmanager

Class RegionManagerGeneralCommands

java.lang.Object

com.lirtistasya.plugins.regionmanager.RegionManagerGeneralCommands

public class RegionManagerGeneralCommands
extends java.lang.Object

RegionManagerGeneralCommands contains all commands that can be executed by both player and console.

Since:

1.0.0

Author:

lirtistasya/mezzodrinker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	RegionManagerGeneralCommands.GenerationRunnable A class managing everything around region definitions.
static class	RegionManagerGeneralCommands.RegionFormatException An exception type used for situations when a region's name does not fit into RegionManager's region name format.
static class	RegionManagerGeneralCommands.Type The types of member a player can be within a region.

Field Summary

Fields

Modifier and Type	Field and Description
private RegionManagerCommandsManager	commands The RegionManagerCommandsManager instance that is used.
private static java.lang.String	MESSAGE_PREFIX private static final String MESSAGE_PREFIX = MessageProperties.MESSAGE_PREFIX;
static java.lang.String	PERMISSION_BROADCAST The permission to receive RegionManager broadcasts.
private RegionManagerPlugin	plugin The RegionManagerPlugin instance that is used.

Constructor Summary

Constructors

Constructor and Description
RegionManagerGeneralCommands(RegionManagerPlugin plugin, RegionManagerCommandsManager commands) Creates a new instance of RegionManagerGeneralCommands with the RegionManagerPlugin and RegionManagerCommandsManager specified.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.bukkit.command.CommandSender sender, java.lang.String regionname, org.bukkit.OfflinePlayer player, RegionManagerGeneralCommands.Type type) Adds a player to a region.
void	clear(org.bukkit.command.CommandSender sender, java.lang.String regionname) Clears a region.
void	exclude(org.bukkit.command.CommandSender sender, java.lang.String regionname) Excludes a region from sale.
void	flags(org.bukkit.command.CommandSender sender, java.lang.String regionname, java.lang.String flag, java.lang.String state) Sets a flag for a region.
boolean	generalCommand(org.bukkit.command.CommandSender sender, java.lang.String[] args) Computes a general command.
void	generate(org.bukkit.command.CommandSender sender, org.bukkit.Chunk chunk, int radius) Generates new regions.
void	help(org.bukkit.command.CommandSender sender) Displays the RegionManager help for a given sender.
void	include(org.bukkit.command.CommandSender sender, java.lang.String regionname) Re-includes a region to sale.
void	info(org.bukkit.command.CommandSender sender, java.lang.String regionname) Shows information about a region.
void	list(org.bukkit.command.CommandSender sender, org.bukkit.OfflinePlayer player) Lists the regions a player is member or owner of.
void	reload(org.bukkit.command.CommandSender sender) Reloads all RegionManager files.
void	remove(org.bukkit.command.CommandSender sender, java.lang.String regionname, org.bukkit.OfflinePlayer player) Removes a player from a region.
void	rminfo(org.bukkit.command.CommandSender sender) Sends the given sender information about RegionManager.
void	save(org.bukkit.command.CommandSender sender) Saves all RegionManager files.

Methods inherited from class java.lang.Object

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

Field Detail

PERMISSION_BROADCAST

public static final java.lang.String PERMISSION_BROADCAST

The permission to receive RegionManager broadcasts.

See Also:

Constant Field Values

plugin

private RegionManagerPlugin plugin

The RegionManagerPlugin instance that is used.

commands

private RegionManagerCommandsManager commands

The RegionManagerCommandsManager instance that is used.

MESSAGE_PREFIX

private static final java.lang.String MESSAGE_PREFIX

private static final String MESSAGE_PREFIX = MessageProperties.MESSAGE_PREFIX;

Constructor Detail

RegionManagerGeneralCommands

public RegionManagerGeneralCommands(RegionManagerPlugin plugin,
                            RegionManagerCommandsManager commands)

Creates a new instance of RegionManagerGeneralCommands with the RegionManagerPlugin and RegionManagerCommandsManager specified.

Parameters:

plugin - the plugin

commands - the RegionManagerCommandsManager instance

Method Detail

generalCommand

public boolean generalCommand(org.bukkit.command.CommandSender sender,
                     java.lang.String[] args)

Computes a general command.

Parameters:

sender - the CommandSender that is executing a command

args - the arguments

Returns:

true if the command was recognized, false if not.

rminfo

public void rminfo(org.bukkit.command.CommandSender sender)

Sends the given sender information about RegionManager.

Parameters:

sender - the sender

help

public void help(org.bukkit.command.CommandSender sender)

Displays the RegionManager help for a given sender.

Parameters:

sender - the sender

info

public void info(org.bukkit.command.CommandSender sender,
        java.lang.String regionname)

Shows information about a region.

Parameters:

sender - the sender

regionname - the region's name

add

public void add(org.bukkit.command.CommandSender sender,
       java.lang.String regionname,
       org.bukkit.OfflinePlayer player,
       RegionManagerGeneralCommands.Type type)

Adds a player to a region.

Parameters:

sender - the sender

regionname - the region's name

player - the player

type - the type of member the player should be

See Also:

RegionManagerGeneralCommands.Type

remove

public void remove(org.bukkit.command.CommandSender sender,
          java.lang.String regionname,
          org.bukkit.OfflinePlayer player)

Removes a player from a region.

Parameters:

sender - the sender

regionname - the region's name

player - the player

exclude

public void exclude(org.bukkit.command.CommandSender sender,
           java.lang.String regionname)

Excludes a region from sale.

Parameters:

sender - the sender

regionname - the region's name

include

public void include(org.bukkit.command.CommandSender sender,
           java.lang.String regionname)

Re-includes a region to sale.

Parameters:

sender - the sender

regionname - the region's name

flags

public void flags(org.bukkit.command.CommandSender sender,
         java.lang.String regionname,
         java.lang.String flag,
         java.lang.String state)

Sets a flag for a region.

Parameters:

sender - the sender

regionname - the region's name

flag - the flag's name

state - the flag's state (normally either "allow" or "deny")

See Also:

getFlagsFor()

list

public void list(org.bukkit.command.CommandSender sender,
        org.bukkit.OfflinePlayer player)

Lists the regions a player is member or owner of.

Parameters:

sender - the sender

player - the player

generate

public void generate(org.bukkit.command.CommandSender sender,
            org.bukkit.Chunk chunk,
            int radius)

Generates new regions.

Parameters:

sender - the sender

chunk - the chunk the definition should be centered

radius - the radius in chunks in which new regions should be defined

clear

public void clear(org.bukkit.command.CommandSender sender,
         java.lang.String regionname)

Clears a region.

Parameters:

sender - the sender

regionname - the region's name

See Also:

clear()

save

public void save(org.bukkit.command.CommandSender sender)

Saves all RegionManager files.

Parameters:

sender - the sender

See Also:

RegionManagerCommandsManager.save()

reload

public void reload(org.bukkit.command.CommandSender sender)

Reloads all RegionManager files.

Parameters:

sender - the sender

See Also:

RegionManagerCommandsManager.reload()