com.palmergames.bukkit.towny.object

Class Town

java.lang.Object

java.util.Observable

com.palmergames.bukkit.towny.object.TownyObject

com.palmergames.bukkit.towny.object.TownyEconomyObject

com.palmergames.bukkit.towny.object.TownBlockOwner

com.palmergames.bukkit.towny.object.Town

All Implemented Interfaces:

ResidentList, Walled

public class Town
extends TownBlockOwner
implements Walled, ResidentList

Constructor Summary

Constructors

Constructor and Description
Town(java.lang.String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addBonusBlocks(int bonusBlocks)
void	addOutpostSpawn(org.bukkit.Location spawn) Add or update an outpost spawn
void	addPurchasedBlocks(int purchasedBlocks)
void	addResident(Resident resident)
void	addResidentCheck(Resident resident)
void	addTownBlock(TownBlock townBlock)
void	addWallSection(WallSection wallSection)
void	clear()
void	collect(double amount)
void	forceAddOutpostSpawn(org.bukkit.Location spawn) Only to be called from the Loading methods.
void	forceSetHomeBlock(TownBlock homeBlock) Only to be called from the Loading methods.
void	forceSetSpawn(org.bukkit.Location spawn) Only to be called from the Loading methods.
java.util.List<org.bukkit.Location>	getAllOutpostSpawns() Get an unmodifiable List of all outpost spawns.
java.util.List<Resident>	getAssistants()
double	getBonusBlockCost()
double	getBonusBlockCostN(int inputN)
int	getBonusBlocks()
double	getCommercialPlotPrice()
double	getCommercialPlotTax()
java.lang.String	getEconomyName() Get a valid economy account name for this object.
double	getEmbassyPlotPrice()
double	getEmbassyPlotTax()
TownBlock	getHomeBlock()
int	getMaxOutpostSpawn()
Resident	getMayor()
Nation	getNation()
int	getNumResidents()
org.bukkit.Location	getOutpostSpawn(java.lang.Integer index) Return the Location for this Outpost index.
double	getPlotPrice()
double	getPlotTax()
double	getPlotTypePrice(TownBlockType type)
int	getPurchasedBlocks()
java.util.List<Resident>	getResidents()
org.bukkit.Location	getSpawn()
java.lang.String	getTag()
double	getTaxes()
int	getTotalBlocks()
java.lang.String	getTownBoard()
java.util.List<java.lang.String>	getTreeString(int depth)
Wall	getWall()
java.util.List<WallSection>	getWallSections()
TownyWorld	getWorld() Fetch the World this town is registered too.
boolean	hasAssistant(Resident resident)
boolean	hasHomeBlock()
boolean	hasMayor()
boolean	hasMobs()
boolean	hasNation()
boolean	hasOutpostSpawn()
boolean	hasResident(Resident resident)
boolean	hasResident(java.lang.String name)
boolean	hasSpawn()
boolean	hasTag()
boolean	hasUpkeep()
boolean	hasWallSection(WallSection wallSection)
boolean	hasWorld()
boolean	isAdminDisabledPVP()
boolean	isAdminEnabledPVP()
boolean	isBANG()
boolean	isCapital()
boolean	isFire()
boolean	isHomeBlock(TownBlock townBlock)
boolean	isMayor(Resident resident)
boolean	isOpen()
boolean	isPublic()
boolean	isPVP()
boolean	isTaxPercentage()
void	removeResident(Resident resident)
void	removeTownBlock(TownBlock townBlock)
void	removeWallSection(WallSection wallSection)
void	setAdminDisabledPVP(boolean isPVPDisabled)
void	setAdminEnabledPVP(boolean isPVPEnabled)
void	setBANG(boolean isBANG)
void	setBonusBlocks(int bonusBlocks)
void	setCommercialPlotPrice(double commercialPlotPrice)
void	setCommercialPlotTax(double commercialTax)
void	setEmbassyPlotPrice(double embassyPlotPrice)
void	setEmbassyPlotTax(double embassyPlotTax)
void	setFire(boolean isFire)
void	setHasMobs(boolean hasMobs)
void	setHasUpkeep(boolean hasUpkeep)
boolean	setHomeBlock(TownBlock homeBlock)
void	setMayor(Resident mayor)
void	setNation(Nation nation)
void	setOpen(boolean isOpen)
void	setPlotPrice(double plotPrice)
void	setPlotTax(double plotTax)
void	setPublic(boolean isPublic)
void	setPurchasedBlocks(int purchasedBlocks)
void	setPVP(boolean isPVP)
void	setSpawn(org.bukkit.Location spawn)
void	setTag(java.lang.String text)
void	setTaxes(double taxes)
void	setTaxPercentage(boolean isPercentage)
void	setTownBoard(java.lang.String townBoard)
void	setWallSections(java.util.List<WallSection> wallSections)
void	setWorld(TownyWorld world) Sets the world this town belongs to.
void	withdrawFromBank(Resident resident, int amount)

Methods inherited from class com.palmergames.bukkit.towny.object.TownBlockOwner

getPermissions, getTownBlocks, hasTownBlock, setPermissions, setTownblocks

Methods inherited from class com.palmergames.bukkit.towny.object.TownyEconomyObject

canPayFromHoldings, collect, getHoldingBalance, getHoldingFormattedBalance, pay, payTo, removeAccount, setBalance

Methods inherited from class com.palmergames.bukkit.towny.object.TownyObject

getFormattedName, getName, getTreeDepth, getUID, isChangedName, setChangedName, setName, setUID, toString

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

Town

public Town(java.lang.String name)

Method Detail

addTownBlock

public void addTownBlock(TownBlock townBlock)
                  throws AlreadyRegisteredException

Overrides:

addTownBlock in class TownBlockOwner

Throws:

AlreadyRegisteredException

setTag

public void setTag(java.lang.String text)
            throws TownyException

Throws:

TownyException

getTag

public java.lang.String getTag()

hasTag

public boolean hasTag()

getMayor

public Resident getMayor()

setTaxes

public void setTaxes(double taxes)

getTaxes

public double getTaxes()

setMayor

public void setMayor(Resident mayor)
              throws TownyException

Throws:

TownyException

getNation

public Nation getNation()
                 throws NotRegisteredException

Throws:

NotRegisteredException

setNation

public void setNation(Nation nation)
               throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

getResidents

public java.util.List<Resident> getResidents()

Specified by:

getResidents in interface ResidentList

getAssistants

public java.util.List<Resident> getAssistants()

hasResident

public boolean hasResident(java.lang.String name)

Specified by:

hasResident in interface ResidentList

hasResident

public boolean hasResident(Resident resident)

hasAssistant

public boolean hasAssistant(Resident resident)

addResident

public void addResident(Resident resident)
                 throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

addResidentCheck

public void addResidentCheck(Resident resident)
                      throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

isMayor

public boolean isMayor(Resident resident)

hasNation

public boolean hasNation()

getNumResidents

public int getNumResidents()

isCapital

public boolean isCapital()

setHasUpkeep

public void setHasUpkeep(boolean hasUpkeep)

hasUpkeep

public boolean hasUpkeep()

setHasMobs

public void setHasMobs(boolean hasMobs)

hasMobs

public boolean hasMobs()

setPVP

public void setPVP(boolean isPVP)

setAdminDisabledPVP

public void setAdminDisabledPVP(boolean isPVPDisabled)

setAdminEnabledPVP

public void setAdminEnabledPVP(boolean isPVPEnabled)

isPVP

public boolean isPVP()

isAdminDisabledPVP

public boolean isAdminDisabledPVP()

isAdminEnabledPVP

public boolean isAdminEnabledPVP()

setBANG

public void setBANG(boolean isBANG)

isBANG

public boolean isBANG()

setTaxPercentage

public void setTaxPercentage(boolean isPercentage)

isTaxPercentage

public boolean isTaxPercentage()

setFire

public void setFire(boolean isFire)

isFire

public boolean isFire()

setTownBoard

public void setTownBoard(java.lang.String townBoard)

getTownBoard

public java.lang.String getTownBoard()

setBonusBlocks

public void setBonusBlocks(int bonusBlocks)

getTotalBlocks

public int getTotalBlocks()

getBonusBlocks

public int getBonusBlocks()

getBonusBlockCost

public double getBonusBlockCost()

getBonusBlockCostN

public double getBonusBlockCostN(int inputN)
                          throws TownyException

Throws:

TownyException

addBonusBlocks

public void addBonusBlocks(int bonusBlocks)

setPurchasedBlocks

public void setPurchasedBlocks(int purchasedBlocks)

getPurchasedBlocks

public int getPurchasedBlocks()

addPurchasedBlocks

public void addPurchasedBlocks(int purchasedBlocks)

setHomeBlock

public boolean setHomeBlock(TownBlock homeBlock)
                     throws TownyException

Parameters:

homeBlock -

Returns:

true if the world/homeblock has changed

Throws:

TownyException

forceSetHomeBlock

public void forceSetHomeBlock(TownBlock homeBlock)
                       throws TownyException

Only to be called from the Loading methods.

Parameters:

homeBlock -

Throws:

TownyException

getHomeBlock

public TownBlock getHomeBlock()
                       throws TownyException

Throws:

TownyException

setWorld

public void setWorld(TownyWorld world)

Sets the world this town belongs to. If it's a world change it will remove the town from the old world and place in the new.

Parameters:

world -

getWorld

public TownyWorld getWorld()

Fetch the World this town is registered too. If (for any reason) it's null it will attempt to find the owning world from TownyUniverse.

Returns:

world or null

hasMayor

public boolean hasMayor()

removeResident

public void removeResident(Resident resident)
                    throws EmptyTownException,
                           NotRegisteredException

Throws:

EmptyTownException

NotRegisteredException

setSpawn

public void setSpawn(org.bukkit.Location spawn)
              throws TownyException

Throws:

TownyException

forceSetSpawn

public void forceSetSpawn(org.bukkit.Location spawn)

Only to be called from the Loading methods.

Parameters:

spawn -

getSpawn

public org.bukkit.Location getSpawn()
                             throws TownyException

Throws:

TownyException

hasSpawn

public boolean hasSpawn()

hasHomeBlock

public boolean hasHomeBlock()

clear

public void clear()
           throws EmptyNationException

Throws:

EmptyNationException

hasWorld

public boolean hasWorld()

removeTownBlock

public void removeTownBlock(TownBlock townBlock)
                     throws NotRegisteredException

Overrides:

removeTownBlock in class TownBlockOwner

Throws:

NotRegisteredException

addOutpostSpawn

public void addOutpostSpawn(org.bukkit.Location spawn)
                     throws TownyException

Add or update an outpost spawn

Parameters:

spawn -

Throws:

TownyException

forceAddOutpostSpawn

public void forceAddOutpostSpawn(org.bukkit.Location spawn)

Only to be called from the Loading methods.

Parameters:

spawn -

getOutpostSpawn

public org.bukkit.Location getOutpostSpawn(java.lang.Integer index)
                                    throws TownyException

Return the Location for this Outpost index.

Parameters:

index -

Returns:

Location of outpost spawn

Throws:

TownyException

getMaxOutpostSpawn

public int getMaxOutpostSpawn()

hasOutpostSpawn

public boolean hasOutpostSpawn()

getAllOutpostSpawns

public java.util.List<org.bukkit.Location> getAllOutpostSpawns()

Get an unmodifiable List of all outpost spawns.

Returns:

List of outpostSpawns

setPlotPrice

public void setPlotPrice(double plotPrice)

getPlotPrice

public double getPlotPrice()

getPlotTypePrice

public double getPlotTypePrice(TownBlockType type)

setCommercialPlotPrice

public void setCommercialPlotPrice(double commercialPlotPrice)

getCommercialPlotPrice

public double getCommercialPlotPrice()

setEmbassyPlotPrice

public void setEmbassyPlotPrice(double embassyPlotPrice)

getEmbassyPlotPrice

public double getEmbassyPlotPrice()

getWall

public Wall getWall()

Specified by:

getWall in interface Walled

getWallSections

public java.util.List<WallSection> getWallSections()

Specified by:

getWallSections in interface Walled

setWallSections

public void setWallSections(java.util.List<WallSection> wallSections)

Specified by:

setWallSections in interface Walled

hasWallSection

public boolean hasWallSection(WallSection wallSection)

Specified by:

hasWallSection in interface Walled

addWallSection

public void addWallSection(WallSection wallSection)

Specified by:

addWallSection in interface Walled

removeWallSection

public void removeWallSection(WallSection wallSection)

Specified by:

removeWallSection in interface Walled

isHomeBlock

public boolean isHomeBlock(TownBlock townBlock)

setPlotTax

public void setPlotTax(double plotTax)

getPlotTax

public double getPlotTax()

setCommercialPlotTax

public void setCommercialPlotTax(double commercialTax)

getCommercialPlotTax

public double getCommercialPlotTax()

setEmbassyPlotTax

public void setEmbassyPlotTax(double embassyPlotTax)

getEmbassyPlotTax

public double getEmbassyPlotTax()

setOpen

public void setOpen(boolean isOpen)

isOpen

public boolean isOpen()

collect

public void collect(double amount)
             throws EconomyException

Throws:

EconomyException

withdrawFromBank

public void withdrawFromBank(Resident resident,
                    int amount)
                      throws EconomyException,
                             TownyException

Throws:

EconomyException

TownyException

getTreeString

public java.util.List<java.lang.String> getTreeString(int depth)

Overrides:

getTreeString in class TownyObject

setPublic

public void setPublic(boolean isPublic)

isPublic

public boolean isPublic()

getEconomyName

public java.lang.String getEconomyName()

Description copied from class: TownyEconomyObject

Get a valid economy account name for this object.

Overrides:

getEconomyName in class TownyEconomyObject

Returns:

account name