com.palmergames.bukkit.towny.command

Class TownCommand

java.lang.Object

com.palmergames.bukkit.towny.command.BaseCommand

com.palmergames.bukkit.towny.command.TownCommand

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter

public class TownCommand
extends BaseCommand
implements org.bukkit.command.CommandExecutor

Send a list of all town help commands to player Command: /town

Constructor Summary

Constructors

Constructor and Description
TownCommand(Towny instance)

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkIfSelectionIsValid(TownBlockOwner owner, java.util.List<WorldCoord> selection, boolean attachedToEdge, double blockCost, boolean force)
static boolean	isEdgeBlock(TownBlockOwner owner, java.util.List<WorldCoord> worldCoords)
static boolean	isEdgeBlock(TownBlockOwner owner, WorldCoord worldCoord)
void	listTowns(org.bukkit.entity.Player player) Send a list of all towns in the universe to player Command: /town list
void	newTown(org.bukkit.entity.Player player, java.lang.String name, java.lang.String mayorName) Create a new town.
Town	newTown(TownyWorld world, java.lang.String name, Resident resident, Coord key, org.bukkit.Location spawn)
boolean	onCommand(org.bukkit.command.CommandSender sender, org.bukkit.command.Command cmd, java.lang.String commandLabel, java.lang.String[] args)
static void	parseTownClaimCommand(org.bukkit.entity.Player player, java.lang.String[] split)
static void	parseTownJoin(org.bukkit.command.CommandSender sender, java.lang.String[] args) If no arguments are given (or error), send usage of command.
static void	parseTownUnclaimCommand(org.bukkit.entity.Player player, java.lang.String[] split)
static void	setTownBlockOwnerPermissions(org.bukkit.entity.Player player, TownBlockOwner townBlockOwner, java.lang.String[] split)
static void	setTownBlockPermissions(org.bukkit.entity.Player player, TownBlockOwner townBlockOwner, TownyPermission perm, java.lang.String[] split, boolean friend)
void	showTownMayorHelp(org.bukkit.entity.Player player)
void	showTownStatusAtCoord(org.bukkit.entity.Player player, TownyWorld world, Coord coord) Send a the status of the town at the target coordinates to the player
void	showTownStatusHere(org.bukkit.entity.Player player) Send a the status of the town the player is physically at to him
static void	townAdd(java.lang.Object sender, Town specifiedTown, java.lang.String[] names) Confirm player is a mayor or assistant, then get list of filter names with online players and invite them to town.
static void	townAddResident(Town town, Resident resident)
static void	townAddResidents(java.lang.Object sender, Town town, java.util.List<Resident> invited)
void	townBuy(org.bukkit.entity.Player player, java.lang.String[] split)
static int	townBuyBonusTownBlocks(Town town, int inputN, java.lang.Object player) Town buys bonus blocks after checking the configured maximum.
void	townDelete(org.bukkit.entity.Player player, java.lang.String[] split)
static void	townKick(org.bukkit.entity.Player player, java.lang.String[] names) Confirm player is a mayor or assistant, then get list of filter names with online players and kick them from town.
static void	townKickResidents(java.lang.Object sender, Resident resident, Town town, java.util.List<Resident> kicking)
void	townLeave(org.bukkit.entity.Player player)
void	townMayor(org.bukkit.entity.Player player, java.lang.String[] split)
void	townRank(org.bukkit.entity.Player player, java.lang.String[] split)
static void	townRemoveResident(Town town, Resident resident)
void	townRename(org.bukkit.entity.Player player, Town town, java.lang.String newName)
void	townSet(org.bukkit.entity.Player player, java.lang.String[] split)
static void	townSpawn(org.bukkit.entity.Player player, java.lang.String[] split, java.lang.Boolean outpost) Wrapper for the townSpawn() method.
static void	townSpawn(org.bukkit.entity.Player player, java.lang.String[] split, Town town, java.lang.String notAffordMSG, java.lang.Boolean outpost) Core spawn function to allow admin use.
void	townToggle(org.bukkit.entity.Player player, java.lang.String[] split)

Methods inherited from class com.palmergames.bukkit.towny.command.BaseCommand

onTabComplete

Methods inherited from class java.lang.Object

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

Constructor Detail

TownCommand

public TownCommand(Towny instance)

Method Detail

onCommand

public boolean onCommand(org.bukkit.command.CommandSender sender,
                org.bukkit.command.Command cmd,
                java.lang.String commandLabel,
                java.lang.String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

listTowns

public void listTowns(org.bukkit.entity.Player player)

Send a list of all towns in the universe to player Command: /town list

Parameters:

player -

townMayor

public void townMayor(org.bukkit.entity.Player player,
             java.lang.String[] split)

showTownStatusHere

public void showTownStatusHere(org.bukkit.entity.Player player)

Send a the status of the town the player is physically at to him

Parameters:

player -

showTownStatusAtCoord

public void showTownStatusAtCoord(org.bukkit.entity.Player player,
                         TownyWorld world,
                         Coord coord)
                           throws TownyException

Send a the status of the town at the target coordinates to the player

Parameters:

player -

world -

coord -

Throws:

TownyException

showTownMayorHelp

public void showTownMayorHelp(org.bukkit.entity.Player player)

townToggle

public void townToggle(org.bukkit.entity.Player player,
              java.lang.String[] split)
                throws TownyException

Throws:

TownyException

townRank

public void townRank(org.bukkit.entity.Player player,
            java.lang.String[] split)
              throws TownyException

Throws:

TownyException

townSet

public void townSet(org.bukkit.entity.Player player,
           java.lang.String[] split)
             throws TownyException

Throws:

TownyException

townBuy

public void townBuy(org.bukkit.entity.Player player,
           java.lang.String[] split)

townBuyBonusTownBlocks

public static int townBuyBonusTownBlocks(Town town,
                         int inputN,
                         java.lang.Object player)
                                  throws TownyException

Town buys bonus blocks after checking the configured maximum.

Parameters:

town -

inputN -

player -

Returns:

The number of purchased bonus blocks.

Throws:

TownyException

newTown

public void newTown(org.bukkit.entity.Player player,
           java.lang.String name,
           java.lang.String mayorName)

Create a new town. Command: /town new [town] *[mayor]

Parameters:

player -

newTown

public Town newTown(TownyWorld world,
           java.lang.String name,
           Resident resident,
           Coord key,
           org.bukkit.Location spawn)
             throws TownyException

Throws:

TownyException

townRename

public void townRename(org.bukkit.entity.Player player,
              Town town,
              java.lang.String newName)

townLeave

public void townLeave(org.bukkit.entity.Player player)

townSpawn

public static void townSpawn(org.bukkit.entity.Player player,
             java.lang.String[] split,
             java.lang.Boolean outpost)
                      throws TownyException

Wrapper for the townSpawn() method. All calls should be through here unless bypassing for admins.

Parameters:

player -

split -

outpost -

Throws:

TownyException

townSpawn

public static void townSpawn(org.bukkit.entity.Player player,
             java.lang.String[] split,
             Town town,
             java.lang.String notAffordMSG,
             java.lang.Boolean outpost)

Core spawn function to allow admin use.

Parameters:

player -

split -

town -

notAffordMSG -

outpost -

townDelete

public void townDelete(org.bukkit.entity.Player player,
              java.lang.String[] split)

townKick

public static void townKick(org.bukkit.entity.Player player,
            java.lang.String[] names)

Confirm player is a mayor or assistant, then get list of filter names with online players and kick them from town. Command: /town kick [resident] .. [resident]

Parameters:

player -

names -

townAddResidents

public static void townAddResidents(java.lang.Object sender,
                    Town town,
                    java.util.List<Resident> invited)

townAddResident

public static void townAddResident(Town town,
                   Resident resident)
                            throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

townRemoveResident

public static void townRemoveResident(Town town,
                      Resident resident)
                               throws EmptyTownException,
                                      NotRegisteredException

Throws:

EmptyTownException

NotRegisteredException

townKickResidents

public static void townKickResidents(java.lang.Object sender,
                     Resident resident,
                     Town town,
                     java.util.List<Resident> kicking)

parseTownJoin

public static void parseTownJoin(org.bukkit.command.CommandSender sender,
                 java.lang.String[] args)

If no arguments are given (or error), send usage of command. If sender is a player: args = [town]. Elsewise: args = [resident] [town]

Parameters:

sender -

args -

townAdd

public static void townAdd(java.lang.Object sender,
           Town specifiedTown,
           java.lang.String[] names)

Confirm player is a mayor or assistant, then get list of filter names with online players and invite them to town. Command: /town add [resident] .. [resident]

Parameters:

sender -

specifiedTown - to add to if not null

names -

setTownBlockOwnerPermissions

public static void setTownBlockOwnerPermissions(org.bukkit.entity.Player player,
                                TownBlockOwner townBlockOwner,
                                java.lang.String[] split)

setTownBlockPermissions

public static void setTownBlockPermissions(org.bukkit.entity.Player player,
                           TownBlockOwner townBlockOwner,
                           TownyPermission perm,
                           java.lang.String[] split,
                           boolean friend)

parseTownClaimCommand

public static void parseTownClaimCommand(org.bukkit.entity.Player player,
                         java.lang.String[] split)

parseTownUnclaimCommand

public static void parseTownUnclaimCommand(org.bukkit.entity.Player player,
                           java.lang.String[] split)

isEdgeBlock

public static boolean isEdgeBlock(TownBlockOwner owner,
                  java.util.List<WorldCoord> worldCoords)

isEdgeBlock

public static boolean isEdgeBlock(TownBlockOwner owner,
                  WorldCoord worldCoord)

checkIfSelectionIsValid

public static void checkIfSelectionIsValid(TownBlockOwner owner,
                           java.util.List<WorldCoord> selection,
                           boolean attachedToEdge,
                           double blockCost,
                           boolean force)
                                    throws TownyException

Throws:

TownyException