Package com.palmergames.bukkit.towny.object

Class Resident

java.lang.Object

com.palmergames.bukkit.towny.object.TownyObject

com.palmergames.bukkit.towny.object.Resident

All Implemented Interfaces:

InviteReceiver, EconomyHandler, Identifiable, Nameable, Permissible, Savable, TownBlockOwner, net.kyori.adventure.audience.Audience, net.kyori.adventure.audience.ForwardingAudience, net.kyori.adventure.audience.ForwardingAudience.Single, net.kyori.adventure.pointer.Pointered

public class Resident
extends TownyObject
implements InviteReceiver, EconomyHandler, TownBlockOwner, Identifiable, net.kyori.adventure.audience.ForwardingAudience.Single

Nested Class Summary

Nested classes/interfaces inherited from interface net.kyori.adventure.audience.ForwardingAudience

net.kyori.adventure.audience.ForwardingAudience.Single

Field Summary

Fields

Modifier and Type	Field	Description
protected com.palmergames.bukkit.towny.object.Resident.CachedTaxOwing	cachedTaxOwing

Constructor Summary

Constructors

Constructor	Description
Resident(String name)

Method Summary

Modifier and Type	Method	Description
void	addFriend(Resident resident)
void	addMetaData(@NotNull CustomDataField<?> md)	Add a specific metadata to this TownyObject.
boolean	addNationRank(String rank)
void	addRespawnProtection(long protectionTime)
void	addTownBlock(TownBlock townBlock)	Adds a townblock to the list of existing townblocks.
boolean	addTownRank(String rank)
@NotNull net.kyori.adventure.audience.Audience	audience()
void	clearModes()
void	clearModes(boolean notify)
void	deleteReceivedInvite(Invite invite)	Removes an invite from the received collection.
boolean	equals(Object other)
boolean	exists()	An internal method used to determine if an object exists in the TownyUniverse's maps.
@NotNull String	getAbout()
Account	getAccount()	Gets the Account associated with this object.
@Nullable Account	getAccountOrNull()
double	getCachedTaxOwing()	Returns a cached amount of taxes that a resident will pay daily.
double	getCachedTaxOwing(boolean refreshIfStale)	Returns a cached amount of taxes that a resident will pay daily, with the ability to only refresh the cache if it is stale.
Confirmation	getConfirmation()
String	getDistrictName()
List<Town>	getEmbassyTowns()	Gets a list of Towns which the given resident owns embassy plots in.
String	getFormattedName()	Gets the formatted name of the object.
String	getFormattedTitleName()
List<Resident>	getFriends()
org.bukkit.inventory.Inventory	getGUIPage()
int	getGUIPageNum()
ArrayList<org.bukkit.inventory.Inventory>	getGUIPages()
SelectionGUI.SelectionType	getGUISelectionType()
@Nullable String	getHighestPriorityNationRank()
@Nullable String	getHighestPriorityTownRank()
Jail	getJail()
double	getJailBailCost()
int	getJailCell()
int	getJailHours()
org.bukkit.Location	getJailSpawn()
Town	getJailTown()
long	getJoinedTownAt()
long	getLastOnline()
List<String>	getModes()
String	getNamePostfix()	Returns King or Mayor postfix set in the Town and Nation Levels of the config.
String	getNamePrefix()	Returns King or Mayor prefix set in the Town and Nation Levels of the config.
Nation	getNation()
@Nullable Nation	getNationOrNull()
List<String>	getNationRanks()
List<String>	getNationRanksForSaving()
TownyPermission	getPermissions()	Gets the permissions of the object.
@Nullable org.bukkit.entity.Player	getPlayer()
String	getPlotGroupName()
String	getPrimaryRankPrefix()
List<Invite>	getReceivedInvites()	Gets the collection of invites received.
long	getRegistered()
String	getSurname()
double	getTaxOwing(boolean useCache)
Account	getTeleportAccount()
int	getTeleportCooldown()
double	getTeleportCost()
org.bukkit.Location	getTeleportDestination()
long	getTeleportRequestTime()
String	getTitle()
Town	getTown()
Collection<TownBlock>	getTownBlocks()	Gets the unmodifiable collection of townblocks.
@Nullable Town	getTownOrNull()	Relatively safe to use after confirming there is a town using hasTown().
List<String>	getTownRanks()
List<String>	getTownRanksForSaving()
List<Town>	getTownsOutlawedIn()
List<String>	getTreeString(int depth)
UUID	getUUID()
boolean	hasDistrictName()
boolean	hasFriend(Resident resident)
int	hashCode()
boolean	hasJailTime()
boolean	hasJailTown(String jailtown)
boolean	hasMode(String mode)
boolean	hasNation()
boolean	hasNationRank(String rank)
boolean	hasPermissionNode(String node)
boolean	hasPlotGroupName()
boolean	hasRequestedTeleport()
boolean	hasRespawnProtection()
boolean	hasSurname()
boolean	hasTitle()
boolean	hasTown()
boolean	hasTownBlock(TownBlock townBlock)	Checks whether object has townblock or not.
boolean	hasTownRank(String rank)
boolean	hasUUID()
boolean	isAdmin()
boolean	isAlliedWith(Resident otherresident)
boolean	isJailed()
boolean	isKing()
boolean	isMayor()
boolean	isNPC()
boolean	isOnline()
boolean	isRespawnPickupWarningShown()
boolean	isSeeingBorderTitles()
void	newReceivedInvite(Invite invite)	Adds an invite to the received collection.
void	removeAllFriends()
void	removeFriend(Resident resident)
void	removeMetaData(@NotNull CustomDataField<?> md)	Remove a specific metadata from the TownyObject.
boolean	removeNationRank(String rank)
void	removeRespawnProtection()
void	removeTown()
void	removeTown(boolean townDeleted)
void	removeTownBlock(TownBlock townBlock)	Removes townblock from the list of existing townblocks.
boolean	removeTownRank(String rank)
void	removeTrustInTown(Town town)
void	resetModes(String[] modes, boolean notify)	Only for internal Towny use.
void	save()	Schedules the object to be saved to the database.
void	setAbout(@NotNull String about)
void	setConfirmation(Confirmation confirmation)
void	setDistrictName(String districtName)
void	setFriends(List<Resident> newFriends)
void	setGUIPageNum(int currentInventoryPage)
void	setGUIPages(ArrayList<org.bukkit.inventory.Inventory> inventory)
void	setGUISelectionType(SelectionGUI.SelectionType selectionType)
void	setJail(Jail jail)
void	setJailBailCost(double bail)
void	setJailCell(int i)
void	setJailHours(Integer hours)
void	setJoinedTownAt(long joinedTownAt)
void	setLastOnline(long lastOnline)
void	setModes(String[] modes, boolean notify)	Deprecated. since 0.100.4.6.
void	setNationRanks(List<String> ranks)
void	setNPC(boolean isNPC)
void	setPermissions(String line)	The the permissions of this object.
void	setPlotGroupName(String plotGroupName)
void	setRegistered(long registered)
void	setRespawnPickupWarningShown(boolean respawnPickupWarningShown)
void	setSurname(String surname)
void	setTitle(String title)
void	setTown(Town town)
void	setTown(Town town, boolean updateJoinedAt)
void	setTownblocks(Collection<TownBlock> townBlocks)
void	setTownRanks(List<String> ranks)
void	setUUID(UUID uuid)	This should only be used by internal loading methods!
void	toggleMode(String[] newModes, boolean notify)	Deprecated. since 0.100.4.6.
void	updatePerms()
void	updatePermsForNationRemoval()

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

addMetaData, getMetadata, getMetadata, getMetadata, getName, getTreeDepth, hasMeta, hasMeta, hasMeta, removeMetaData, removeMetaData, removeMetaData, setName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kyori.adventure.audience.Audience

deleteMessage, openBook, removeResourcePacks, removeResourcePacks, removeResourcePacks, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendResourcePacks, showTitle, stopSound

Methods inherited from interface net.kyori.adventure.audience.ForwardingAudience.Single

audiences, clearResourcePacks, clearTitle, deleteMessage, filterAudience, forEachAudience, get, getOrDefault, getOrDefaultFrom, hideBossBar, openBook, playSound, playSound, playSound, pointers, removeResourcePacks, removeResourcePacks, resetTitle, sendActionBar, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendPlayerListFooter, sendPlayerListHeader, sendPlayerListHeaderAndFooter, sendResourcePacks, sendTitlePart, showBossBar, showDialog, stopSound

Methods inherited from interface com.palmergames.bukkit.towny.object.Nameable

getName

Field Details

cachedTaxOwing

protected com.palmergames.bukkit.towny.object.Resident.CachedTaxOwing cachedTaxOwing

Constructor Details

Resident

public Resident(String name)

Method Details

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setLastOnline

public void setLastOnline(long lastOnline)

getLastOnline

public long getLastOnline()

setNPC

public void setNPC(boolean isNPC)

isNPC

public boolean isNPC()

getUUID

public UUID getUUID()

Specified by:

getUUID in interface Identifiable

setUUID

public void setUUID(UUID uuid)

Description copied from interface: Identifiable

This should only be used by internal loading methods!

Specified by:

setUUID in interface Identifiable

Parameters:

uuid - the UUID to set.

hasUUID

public boolean hasUUID()

getJail

public Jail getJail()

setJail

public void setJail(Jail jail)

isJailed

public boolean isJailed()

getJailCell

public int getJailCell()

setJailCell

public void setJailCell(int i)

getJailTown

public Town getJailTown()

hasJailTown

public boolean hasJailTown(String jailtown)

getJailHours

public int getJailHours()

setJailHours

public void setJailHours(Integer hours)

getJailBailCost

public double getJailBailCost()

setJailBailCost

public void setJailBailCost(double bail)

hasJailTime

public boolean hasJailTime()

getJailSpawn

public org.bukkit.Location getJailSpawn()

getPrimaryRankPrefix

public String getPrimaryRankPrefix()

setTitle

public void setTitle(String title)

getTitle

public String getTitle()

hasTitle

public boolean hasTitle()

setSurname

public void setSurname(String surname)

getSurname

public String getSurname()

hasSurname

public boolean hasSurname()

setAbout

public void setAbout(@NotNull
 @NotNull String about)

getAbout

@NotNull
public @NotNull String getAbout()

isKing

public boolean isKing()

isMayor

public boolean isMayor()

hasTown

public boolean hasTown()

hasNation

public boolean hasNation()

getTown

public Town getTown()
             throws NotRegisteredException

Throws:

NotRegisteredException

getTownOrNull

@Nullable
public @Nullable Town getTownOrNull()

Relatively safe to use after confirming there is a town using hasTown().

Returns:

Town the resident belongs to or null.

setTown

public void setTown(Town town)
             throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

setTown

public void setTown(Town town,
 boolean updateJoinedAt)
             throws AlreadyRegisteredException

Throws:

AlreadyRegisteredException

removeTown

public void removeTown()

removeTown

public void removeTown(boolean townDeleted)

setFriends

public void setFriends(List<Resident> newFriends)

getFriends

public List<Resident> getFriends()

removeFriend

public void removeFriend(Resident resident)

hasFriend

public boolean hasFriend(Resident resident)

addFriend

public void addFriend(Resident resident)

removeAllFriends

public void removeAllFriends()

updatePerms

public void updatePerms()

updatePermsForNationRemoval

public void updatePermsForNationRemoval()

setRegistered

public void setRegistered(long registered)

getRegistered

public long getRegistered()

getTreeString

public List<String> getTreeString(int depth)

Overrides:

getTreeString in class TownyObject

getTeleportRequestTime

@Obsolete
public long getTeleportRequestTime()

getTeleportDestination

@Obsolete
public org.bukkit.Location getTeleportDestination()

getTeleportCooldown

@Obsolete
public int getTeleportCooldown()

hasRequestedTeleport

public boolean hasRequestedTeleport()

Returns:

Whether this resident has an active teleport warmup that they're waiting for.

getTeleportCost

@Obsolete
public double getTeleportCost()

getTeleportAccount

@Obsolete
public Account getTeleportAccount()

hasPermissionNode

public boolean hasPermissionNode(String node)

Parameters:

node - String representing a PermissionNode to test for.

Returns:

true if the Player of the Resident has the permission node assigned to them according to the TownyPermissionSource.

isAdmin

public boolean isAdmin()

Returns:

true if the Player of the Resident is a server OP or has the towny.admin permission node according to the TownyPermissionSource.

getModes

public List<String> getModes()

hasMode

public boolean hasMode(String mode)

toggleMode

@Deprecated
public void toggleMode(String[] newModes,
 boolean notify)

Deprecated.

since 0.100.4.6. Use ResidentModeHandler.toggleModes(Resident, String[], boolean, boolean) instead.

Parameters:

newModes -

notify -

setModes

@Deprecated
public void setModes(String[] modes,
 boolean notify)

Deprecated.

since 0.100.4.6. Use ResidentModeHandler.toggleModes(Resident, String[], boolean, boolean) instead.

Parameters:

modes -

notify -

clearModes

public void clearModes()

clearModes

public void clearModes(boolean notify)

resetModes

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

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

Parameters:

modes - - String Array of modes

notify - - If notifications should be sent

getPlayer

@Nullable
public @Nullable org.bukkit.entity.Player getPlayer()

addTownRank

public boolean addTownRank(String rank)

setTownRanks

public void setTownRanks(List<String> ranks)

hasTownRank

public boolean hasTownRank(String rank)

getTownRanks

public List<String> getTownRanks()

getTownRanksForSaving

@Internal
public List<String> getTownRanksForSaving()

removeTownRank

public boolean removeTownRank(String rank)

getHighestPriorityTownRank

@Nullable
public @Nullable String getHighestPriorityTownRank()

addNationRank

public boolean addNationRank(String rank)

setNationRanks

public void setNationRanks(List<String> ranks)

hasNationRank

public boolean hasNationRank(String rank)

getNationRanks

public List<String> getNationRanks()

getNationRanksForSaving

@Internal
public List<String> getNationRanksForSaving()

removeNationRank

public boolean removeNationRank(String rank)

getHighestPriorityNationRank

@Nullable
public @Nullable String getHighestPriorityNationRank()

isAlliedWith

public boolean isAlliedWith(Resident otherresident)

getReceivedInvites

public List<Invite> getReceivedInvites()

Description copied from interface: InviteReceiver

Gets the collection of invites received.

Specified by:

getReceivedInvites in interface InviteReceiver

Returns:

An unmodifiable collection of received invites.

newReceivedInvite

public void newReceivedInvite(Invite invite)
                       throws TooManyInvitesException

Description copied from interface: InviteReceiver

Adds an invite to the received collection.

Specified by:

newReceivedInvite in interface InviteReceiver

Parameters:

invite - The invite to add.

Throws:

TooManyInvitesException - When the invite cap is reached.

deleteReceivedInvite

public void deleteReceivedInvite(Invite invite)

Description copied from interface: InviteReceiver

Removes an invite from the received collection.

Specified by:

deleteReceivedInvite in interface InviteReceiver

Parameters:

invite - The invite to remove.

addMetaData

public void addMetaData(@NotNull
 @NotNull CustomDataField<?> md)

Description copied from class: TownyObject

Add a specific metadata to this TownyObject. Overrides existing metadata of the same key. Most implementations will save the object after this method is called.

Overrides:

addMetaData in class TownyObject

Parameters:

md - CustomDataField to add.

removeMetaData

public void removeMetaData(@NotNull
 @NotNull CustomDataField<?> md)

Description copied from class: TownyObject

Remove a specific metadata from the TownyObject. The metadata does not need to be the same instance of the one added, but must have the same key. Most implementations will save the TownyObject after removing the metadata.

Overrides:

removeMetaData in class TownyObject

Parameters:

md - CustomDataField to remove.

getAccount

public Account getAccount()

Description copied from interface: EconomyHandler

Gets the Account associated with this object.

Specified by:

getAccount in interface EconomyHandler

Returns:

An Account for this class.

getAccountOrNull

@Nullable
public @Nullable Account getAccountOrNull()

getFormattedName

public String getFormattedName()

Description copied from interface: Nameable

Gets the formatted name of the object.

Specified by:

getFormattedName in interface Nameable

Returns:

The formatted name.

getNamePrefix

public String getNamePrefix()

Returns King or Mayor prefix set in the Town and Nation Levels of the config.

Returns:

Prefix of a King or Mayor if resident is a king or mayor.

getNamePostfix

public String getNamePostfix()

Returns King or Mayor postfix set in the Town and Nation Levels of the config.

Returns:

Postfix of a King or Mayor if resident is a king or mayor.

getFormattedTitleName

public String getFormattedTitleName()

setTownblocks

public void setTownblocks(Collection<TownBlock> townBlocks)

getTownBlocks

public Collection<TownBlock> getTownBlocks()

Description copied from interface: TownBlockOwner

Gets the unmodifiable collection of townblocks.

Specified by:

getTownBlocks in interface TownBlockOwner

Returns:

The townblocks this object contains.

getTownsOutlawedIn

public List<Town> getTownsOutlawedIn()

Returns:

All towns that the resident is outlawed in

hasTownBlock

public boolean hasTownBlock(TownBlock townBlock)

Description copied from interface: TownBlockOwner

Checks whether object has townblock or not.

Specified by:

hasTownBlock in interface TownBlockOwner

Parameters:

townBlock - The townblock to check for.

Returns:

A boolean indicating if it was found or not.

addTownBlock

public void addTownBlock(TownBlock townBlock)
                  throws AlreadyRegisteredException

Description copied from interface: TownBlockOwner

Adds a townblock to the list of existing townblocks.

Specified by:

addTownBlock in interface TownBlockOwner

Parameters:

townBlock - The townblock to add.

Throws:

AlreadyRegisteredException - When the townblock is already in the list.

removeTownBlock

public void removeTownBlock(TownBlock townBlock)

Description copied from interface: TownBlockOwner

Removes townblock from the list of existing townblocks.

Specified by:

removeTownBlock in interface TownBlockOwner

Parameters:

townBlock - The townblock to remove.

setPermissions

public void setPermissions(String line)

Description copied from interface: Permissible

The the permissions of this object.

Specified by:

setPermissions in interface Permissible

Parameters:

line - The String line representation of the permissions.

getPermissions

public TownyPermission getPermissions()

Description copied from interface: Permissible

Gets the permissions of the object.

Specified by:

getPermissions in interface Permissible

Returns:

TownyPermission the permissions of the object.

getConfirmation

public Confirmation getConfirmation()

setConfirmation

public void setConfirmation(Confirmation confirmation)

getGUIPage

public org.bukkit.inventory.Inventory getGUIPage()

Returns:

the current inventory which the player is looking at for the GUIs.

getGUIPages

public ArrayList<org.bukkit.inventory.Inventory> getGUIPages()

setGUIPages

public void setGUIPages(ArrayList<org.bukkit.inventory.Inventory> inventory)

getGUIPageNum

public int getGUIPageNum()

setGUIPageNum

public void setGUIPageNum(int currentInventoryPage)

getGUISelectionType

public SelectionGUI.SelectionType getGUISelectionType()

setGUISelectionType

public void setGUISelectionType(SelectionGUI.SelectionType selectionType)

save

public void save()

Description copied from interface: Savable

Schedules the object to be saved to the database.

Specified by:

save in interface Savable

getEmbassyTowns

public List<Town> getEmbassyTowns()

Gets a list of Towns which the given resident owns embassy plots in.

Returns:

List of Towns in which the resident owns embassies.

getJoinedTownAt

public long getJoinedTownAt()

setJoinedTownAt

public void setJoinedTownAt(long joinedTownAt)

getNation

public Nation getNation()
                 throws TownyException

Throws:

TownyException

getNationOrNull

@Nullable
public @Nullable Nation getNationOrNull()

isOnline

public boolean isOnline()

hasRespawnProtection

public boolean hasRespawnProtection()

addRespawnProtection

public void addRespawnProtection(long protectionTime)

removeRespawnProtection

public void removeRespawnProtection()

isRespawnPickupWarningShown

public boolean isRespawnPickupWarningShown()

setRespawnPickupWarningShown

public void setRespawnPickupWarningShown(boolean respawnPickupWarningShown)

audience

@NotNull
public @NotNull net.kyori.adventure.audience.Audience audience()

Specified by:

audience in interface net.kyori.adventure.audience.ForwardingAudience.Single

isSeeingBorderTitles

public boolean isSeeingBorderTitles()

hasPlotGroupName

public boolean hasPlotGroupName()

getPlotGroupName

public String getPlotGroupName()

setPlotGroupName

public void setPlotGroupName(String plotGroupName)

hasDistrictName

public boolean hasDistrictName()

getDistrictName

public String getDistrictName()

setDistrictName

public void setDistrictName(String districtName)

exists

@Internal
public boolean exists()

Description copied from class: TownyObject

An internal method used to determine if an object exists in the TownyUniverse's maps.

Specified by:

exists in class TownyObject

Returns:

true if this TownyObject exists.

getTaxOwing

public double getTaxOwing(boolean useCache)

getCachedTaxOwing

public double getCachedTaxOwing()

Returns a cached amount of taxes that a resident will pay daily.

Returns:

tax Double which is from a Resident.CachedTaxOwing.owing.

getCachedTaxOwing

public double getCachedTaxOwing(boolean refreshIfStale)

Returns a cached amount of taxes that a resident will pay daily, with the ability to only refresh the cache if it is stale.

Parameters:

refreshIfStale - when true, if the cache is stale it will update.

Returns:

cachedTaxOwing Double which is from a Resident.CachedTaxOwing.owing.

removeTrustInTown

public void removeTrustInTown(Town town)