com.palmergames.bukkit.towny.object

Class Resident

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.Resident

All Implemented Interfaces:

ResidentModes

public class Resident
extends TownBlockOwner
implements ResidentModes

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addFriend(Resident resident)
boolean	addNationRank(java.lang.String rank)
boolean	addTownRank(java.lang.String rank)
void	addUndo(java.lang.Object[][][] snapshot) Push a snapshot to the Undo queue
void	clear()
void	clearModes()
void	clearTeleportRequest()
java.lang.String	getChatFormattedName()
java.util.List<Resident>	getFriends()
long	getLastOnline()
java.util.List<java.lang.String>	getModes()
java.util.List<java.lang.String>	getNationRanks()
long	getRegistered()
java.lang.String	getSurname()
double	getTeleportCost()
org.bukkit.Location	getTeleportDestination()
long	getTeleportRequestTime()
java.lang.String	getTitle()
Town	getTown()
java.util.List<java.lang.String>	getTownRanks()
java.util.List<java.lang.String>	getTreeString(int depth)
boolean	hasFriend(Resident resident)
boolean	hasMode(java.lang.String mode)
boolean	hasNation()
boolean	hasNationRank(java.lang.String rank)
boolean	hasRequestedTeleport()
boolean	hasSurname()
boolean	hasTitle()
boolean	hasTown()
boolean	hasTownRank(java.lang.String rank)
boolean	isKing()
boolean	isMayor()
boolean	isNPC()
void	regenUndo()
void	removeAllFriends()
boolean	removeFriend(Resident resident)
boolean	removeNationRank(java.lang.String rank)
boolean	removeTownRank(java.lang.String rank)
void	resetModes(java.lang.String[] modes, boolean notify) Only for internal Towny use.
void	setChatFormattedName(java.lang.String chatFormattedName)
void	setFriends(java.util.List<Resident> newFriends)
void	setLastOnline(long lastOnline)
void	setModes(java.lang.String[] modes, boolean notify)
void	setNationRanks(java.util.List<java.lang.String> ranks)
void	setNPC(boolean isNPC)
void	setRegistered(long registered)
void	setSurname(java.lang.String surname)
void	setTeleportCost(double cost)
void	setTeleportDestination(org.bukkit.Location spawnLoc)
void	setTeleportRequestTime()
void	setTitle(java.lang.String title)
void	setTown(Town town)
void	setTownRanks(java.util.List<java.lang.String> ranks)
void	toggleMode(java.lang.String[] newModes, boolean notify)

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

addTownBlock, getPermissions, getTownBlocks, hasTownBlock, removeTownBlock, setPermissions, setTownblocks

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

canPayFromHoldings, collect, getEconomyName, 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

Resident

public Resident(java.lang.String name)

Method Detail

setLastOnline

public void setLastOnline(long lastOnline)

getLastOnline

public long getLastOnline()

setNPC

public void setNPC(boolean isNPC)

isNPC

public boolean isNPC()

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

hasTitle

public boolean hasTitle()

setSurname

public void setSurname(java.lang.String surname)

getSurname

public java.lang.String getSurname()

hasSurname

public boolean hasSurname()

isKing

public boolean isKing()

isMayor

public boolean isMayor()

hasTown

public boolean hasTown()

hasNation

public boolean hasNation()

getTown

public Town getTown()
             throws NotRegisteredException

Throws:

NotRegisteredException

setTown

public void setTown(Town town)
             throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

setFriends

public void setFriends(java.util.List<Resident> newFriends)

getFriends

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

removeFriend

public boolean removeFriend(Resident resident)
                     throws NotRegisteredException

Throws:

NotRegisteredException

hasFriend

public boolean hasFriend(Resident resident)

addFriend

public void addFriend(Resident resident)
               throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

removeAllFriends

public void removeAllFriends()

clear

public void clear()
           throws EmptyTownException

Throws:

EmptyTownException

setRegistered

public void setRegistered(long registered)

getRegistered

public long getRegistered()

getTreeString

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

Overrides:

getTreeString in class TownyObject

clearTeleportRequest

public void clearTeleportRequest()

setTeleportRequestTime

public void setTeleportRequestTime()

getTeleportRequestTime

public long getTeleportRequestTime()

setTeleportDestination

public void setTeleportDestination(org.bukkit.Location spawnLoc)

getTeleportDestination

public org.bukkit.Location getTeleportDestination()

hasRequestedTeleport

public boolean hasRequestedTeleport()

setTeleportCost

public void setTeleportCost(double cost)

getTeleportCost

public double getTeleportCost()

getChatFormattedName

public java.lang.String getChatFormattedName()

Returns:

the chatFormattedName

setChatFormattedName

public void setChatFormattedName(java.lang.String chatFormattedName)

Parameters:

chatFormattedName - the chatFormattedName to set

addUndo

public void addUndo(java.lang.Object[][][] snapshot)

Push a snapshot to the Undo queue

Parameters:

snapshot -

regenUndo

public void regenUndo()

getModes

public java.util.List<java.lang.String> getModes()

Specified by:

getModes in interface ResidentModes

hasMode

public boolean hasMode(java.lang.String mode)

Specified by:

hasMode in interface ResidentModes

toggleMode

public void toggleMode(java.lang.String[] newModes,
              boolean notify)

Specified by:

toggleMode in interface ResidentModes

setModes

public void setModes(java.lang.String[] modes,
            boolean notify)

Specified by:

setModes in interface ResidentModes

clearModes

public void clearModes()

Specified by:

clearModes in interface ResidentModes

resetModes

public void resetModes(java.lang.String[] modes,
              boolean notify)

Only for internal Towny use. NEVER call this from any other plugin.

Parameters:

modes -

notify -

addTownRank

public boolean addTownRank(java.lang.String rank)
                    throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

setTownRanks

public void setTownRanks(java.util.List<java.lang.String> ranks)

hasTownRank

public boolean hasTownRank(java.lang.String rank)

getTownRanks

public java.util.List<java.lang.String> getTownRanks()

removeTownRank

public boolean removeTownRank(java.lang.String rank)
                       throws NotRegisteredException

Throws:

NotRegisteredException

addNationRank

public boolean addNationRank(java.lang.String rank)
                      throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

setNationRanks

public void setNationRanks(java.util.List<java.lang.String> ranks)

hasNationRank

public boolean hasNationRank(java.lang.String rank)

getNationRanks

public java.util.List<java.lang.String> getNationRanks()

removeNationRank

public boolean removeNationRank(java.lang.String rank)
                         throws NotRegisteredException

Throws:

NotRegisteredException