Uses of Class
com.palmergames.bukkit.towny.object.Resident

Packages that use Resident

Package	Description
com.palmergames.bukkit.towny
com.palmergames.bukkit.towny.command
com.palmergames.bukkit.towny.db
com.palmergames.bukkit.towny.event
com.palmergames.bukkit.towny.event.damage
com.palmergames.bukkit.towny.event.deathprice
com.palmergames.bukkit.towny.event.nation
com.palmergames.bukkit.towny.event.nation.toggle
com.palmergames.bukkit.towny.event.player
com.palmergames.bukkit.towny.event.plot
com.palmergames.bukkit.towny.event.plot.changeowner
com.palmergames.bukkit.towny.event.resident
com.palmergames.bukkit.towny.event.statusscreen
com.palmergames.bukkit.towny.event.teleport
com.palmergames.bukkit.towny.event.town
com.palmergames.bukkit.towny.event.town.toggle
com.palmergames.bukkit.towny.listeners
com.palmergames.bukkit.towny.object
com.palmergames.bukkit.towny.object.gui
com.palmergames.bukkit.towny.object.inviteobjects
com.palmergames.bukkit.towny.object.resident.mode
com.palmergames.bukkit.towny.permissions
com.palmergames.bukkit.towny.tasks
com.palmergames.bukkit.towny.utils
com.palmergames.bukkit.util

Uses of Resident in com.palmergames.bukkit.towny

Methods in com.palmergames.bukkit.towny that return Resident

Modifier and Type	Method	Description
@Nullable Resident	TownyAPI.getResident(String name)	Gets the resident from the given name.
@Nullable Resident	TownyAPI.getResident(UUID uuid)	Gets the resident from the given UUID.
@Nullable Resident	TownyAPI.getResident(org.bukkit.entity.Player player)	Gets the resident from the given Player.
@Nullable Resident	TownyUniverse.getResident(@NotNull String residentName)	Get the resident matching the passed in name.
@Nullable Resident	TownyUniverse.getResident(@NotNull UUID residentUUID)	Get the resident with the passed-in UUID.
@Nullable Resident	TownyAPI.getResidentOrNull(TownBlock townBlock)	Get the Resident who owns the TownBlock or null.
@NotNull Resident	TownyAPI.getResidentOrThrow(@Nullable org.bukkit.entity.Player player)	Gets the resident from the given Player or throws a TownyException if that isn't possible.

Methods in com.palmergames.bukkit.towny that return types with arguments of type Resident

Modifier and Type	Method	Description
List<Resident>	TownyUniverse.getJailedResidentMap()
List<Resident>	TownyAPI.getOnlineResidents(ResidentList owner)	Check which Residents are online in a ResidentList
@NotNull Optional<Resident>	TownyUniverse.getResidentOpt(@NotNull String residentName)	Get an optional instance of the resident matching the passed in name.
@NotNull Optional<Resident>	TownyUniverse.getResidentOpt(@NotNull UUID residentUUID)	Get an optional object that may contain the resident with the passed-in UUID.
List<Resident>	TownyAPI.getResidents()	Gets a List of all of the Residents on the server.
List<Resident>	TownyAPI.getResidents(String[] names)	Get a List of Resident from an array of names.
List<Resident>	TownyAPI.getResidents(UUID[] uuids)	Get a List of Resident from an array of UUIDs.
@Unmodifiable Collection<Resident>	TownyUniverse.getResidents()
List<Resident>	TownyAPI.getResidentsWithoutTown()	Gets a List of all the Residents which don't belong to a town.

Methods in com.palmergames.bukkit.towny with parameters of type Resident

Modifier and Type	Method	Description
void	TownyAPI.abortTeleportRequest(Resident resident)
void	TownyAPI.abortTeleportRequest(Resident resident, CancelledTownyTeleportEvent.CancelledTeleportReason reason)
void	Towny.deleteCache(Resident resident)
String	ChunkNotification.getAreaNotification(Resident resident)
String	ChunkNotification.getAreaPvPNotification(Resident resident)
static String	TownySettings.getKingPostfix(Resident resident)
static String	TownySettings.getKingPrefix(Resident resident)
static int	TownySettings.getMaxResidentExtraPlots(Resident resident)
static int	TownySettings.getMaxResidentOutposts(Resident resident)
static int	TownySettings.getMaxResidentPlots(Resident resident)
static String	TownySettings.getMayorPostfix(Resident resident)
static String	TownySettings.getMayorPrefix(Resident resident)
List<String>	ChunkNotification.getNotificationContent(Resident resident)
String	ChunkNotification.getNotificationString(Resident resident)
String	ChunkNotification.getOwnerOrPlotNameNotification(Resident resident)
org.bukkit.entity.Player	TownyAPI.getPlayer(Resident resident)	Find the the matching Player of the specified Resident.
@Nullable UUID	TownyAPI.getPlayerUUID(Resident resident)	Find the UUID for the matching Player of the specified Resident.
@Nullable Nation	TownyAPI.getResidentNationOrNull(Resident resident)	Gets the resident's nation if they have one.
@Nullable Town	TownyAPI.getResidentTownOrNull(Resident resident)	Gets the resident's town if they have one.
static StatusScreen	TownyFormatter.getStatus(Resident resident, org.bukkit.command.CommandSender sender)	Gets the status screen of a Resident
static List<String>	TownyFormatter.getTaxStatus(Resident resident, Translator translator)	Returns the tax info this resident will have to pay at the next new day.
String	ChunkNotification.getTownPVPNotification(Resident resident)
void	TownyUniverse.registerResident(@NotNull Resident resident)	Register a resident into the internal structures.
void	TownyUniverse.registerResidentUUID(@NotNull Resident resident)
static void	TownyMessaging.sendMsg(Resident resident, Translatable message)	Send a translatable message to a resident if they are online, prefixed by the default_towny_prefix.
static void	TownyMessaging.sendPlotList(org.bukkit.command.CommandSender sender, Resident resident, int page, int totalPages)
static void	TownyMessaging.sendPrefixedTownMessage(Resident resident, Translatable message)	Sends a message to all online residents of the specified resident's town, if they have one.
static void	TownyMessaging.sendTitleMessageToResident(Resident resident, String title, String subtitle)	Send a Title and Subtitle to a resident with default duration (70 ticks.)
static void	TownyMessaging.sendTitleMessageToResident(Resident resident, String title, String subtitle, int duration)	Send a Title and Subtitle to a resident for a specified number of ticks.
void	TownyAPI.testPlotOwnerOrThrow(@NotNull Resident resident, @NotNull TownBlock townBlock)	Test the townBlock to ensure it is owned by the given Resident, or the Resident is considered a Mayor or Town Assistant or a TownyAdmin.
void	TownyUniverse.unregisterResident(@NotNull Resident resident)	Unregister a resident from the internal structures.

Uses of Resident in com.palmergames.bukkit.towny.command

Methods in com.palmergames.bukkit.towny.command that return Resident

Modifier and Type	Method	Description
protected static @NotNull Resident	BaseCommand.getResidentOrThrow(String residentName)
protected static @NotNull Resident	BaseCommand.getResidentOrThrow(UUID playerUUID)
protected static @NotNull Resident	BaseCommand.getResidentOrThrow(@Nullable org.bukkit.entity.Player player)

Methods in com.palmergames.bukkit.towny.command with parameters of type Resident

Modifier and Type	Method	Description
static void	BaseCommand.catchNPCResident(Resident resident)
protected static @NotNull Nation	BaseCommand.getNationFromResidentOrThrow(Resident resident)
protected static @NotNull Town	BaseCommand.getTownFromResidentOrThrow(@NotNull Resident resident)
static void	TownyAdminCommand.handleResidentMetaCommand(org.bukkit.command.CommandSender sender, Resident resident, String[] split)
void	NationCommand.nationAddOrRemoveAlly(Resident resident, Nation nation, List<Nation> targetNations, boolean add)
static Town	TownCommand.newTown(TownyWorld world, String name, Resident resident, Coord key, org.bukkit.Location spawn, org.bukkit.entity.Player player)
static Town	TownCommand.newTown(TownyWorld world, String name, Resident resident, Coord key, org.bukkit.Location spawn, org.bukkit.entity.Player player, double cost)
static void	TownCommand.newTown(org.bukkit.entity.Player player, String name, Resident resident, boolean noCharge)	Create a new town.
static void	TownCommand.newTown(org.bukkit.entity.Player player, String name, Resident resident, boolean noCharge, boolean adminCreated)	Create a new town.
void	PlotCommand.parsePlotClaim(org.bukkit.entity.Player player, String[] args, Resident resident, TownBlock townBlock)
void	PlotCommand.parsePlotClear(Resident resident, TownBlock townBlock)
void	PlotCommand.parsePlotEvict(Resident resident, TownBlock townBlock)
void	PlotCommand.parsePlotForSale(org.bukkit.entity.Player player, String[] split, Resident resident, TownBlock townBlock)
void	PlotCommand.parsePlotGroupForSale(String[] split, Resident resident, TownBlock townBlock, org.bukkit.entity.Player player, Town town)
void	PlotCommand.parsePlotGroupNotForSale(Resident resident, TownBlock townBlock, org.bukkit.entity.Player player, Town town)
void	PlotCommand.parsePlotGroupPerm(String[] split, Resident resident, TownBlock townBlock, org.bukkit.entity.Player player)
void	PlotCommand.parsePlotGroupSet(String[] split, Resident resident, TownBlock townBlock, org.bukkit.entity.Player player, Town town)
void	PlotCommand.parsePlotGroupSetTownBlockType(String[] split, Resident resident, TownBlock townBlock, PlotGroup group, org.bukkit.entity.Player player, Town town)
void	PlotCommand.parsePlotGroupToggle(String[] split, TownBlock townBlock, org.bukkit.entity.Player player, Resident resident)
void	PlotCommand.parsePlotNotForSale(org.bukkit.entity.Player player, String[] args, Resident resident, TownBlock townBlock)
void	PlotCommand.parsePlotSet(org.bukkit.entity.Player player, String[] split, Resident resident, TownBlock townBlock)
void	PlotCommand.parsePlotSetOutpost(org.bukkit.entity.Player player, Resident resident, TownBlock townBlock, boolean spawn)
void	PlotCommand.parsePlotUnclaim(org.bukkit.entity.Player player, String[] split, Resident resident)
void	PlotCommand.plotGroupToggle(org.bukkit.entity.Player player, Resident resident, PlotGroup plotGroup, String[] split)	Toggle the plot group flags for pvp/explosion/fire/mobs (if town/world permissions allow)
void	PlotCommand.plotToggle(org.bukkit.entity.Player player, Resident resident, TownBlock townBlock, String[] split)	Toggle the plots flags for pvp/explosion/fire/mobs (if town/world permissions allow)
void	TownyAdminCommand.residentDelete(org.bukkit.command.CommandSender sender, Resident resident)	Delete a resident and their data file afer a successful confirmation.
static void	ResidentCommand.residentFriend(org.bukkit.entity.Player player, String[] split, boolean admin, Resident resident)
static void	ResidentCommand.residentFriendAdd(org.bukkit.entity.Player player, Resident resident, List<Resident> friending)
static void	ResidentCommand.residentFriendRemove(org.bukkit.entity.Player player, Resident resident, List<Resident> unFriending)
void	PlotCommand.setPlotForSale(Resident resident, WorldCoord worldCoord, double forSale)	Set the plot for sale/not for sale if permitted
static void	TownCommand.townAddResident(Town town, Resident resident)
static void	TownCommand.townSetMayor(org.bukkit.command.CommandSender sender, String[] split, boolean admin, Town town, Resident resident)

Method parameters in com.palmergames.bukkit.towny.command with type arguments of type Resident

Modifier and Type	Method	Description
static void	ResidentCommand.residentFriendAdd(org.bukkit.entity.Player player, Resident resident, List<Resident> friending)
static void	ResidentCommand.residentFriendRemove(org.bukkit.entity.Player player, Resident resident, List<Resident> unFriending)
static void	TownCommand.townAddResidents(org.bukkit.command.CommandSender sender, Town town, List<Resident> invited)

Uses of Resident in com.palmergames.bukkit.towny.db

Methods in com.palmergames.bukkit.towny.db that return Resident

Modifier and Type	Method	Description
@NotNull Resident	TownyDatabaseHandler.newResident(String name)
@NotNull Resident	TownyDatabaseHandler.newResident(String name, UUID uuid)
abstract @NotNull Resident	TownyDataSource.newResident(String name)
abstract @NotNull Resident	TownyDataSource.newResident(String name, UUID uuid)

Methods in com.palmergames.bukkit.towny.db with parameters of type Resident

Modifier and Type	Method	Description
abstract void	TownyDataSource.deleteResident(Resident resident)
void	TownyFlatFileSource.deleteResident(Resident resident)
void	TownySQLSource.deleteResident(Resident resident)
String	TownyFlatFileSource.getResidentFilename(Resident resident)
abstract boolean	TownyDataSource.loadResident(Resident resident)
boolean	TownyFlatFileSource.loadResident(Resident resident)
boolean	TownySQLSource.loadResident(Resident resident)
void	TownyDatabaseHandler.removeResident(Resident resident)
abstract void	TownyDataSource.removeResident(Resident resident)
void	TownyDatabaseHandler.renamePlayer(Resident resident, String newName)
abstract void	TownyDataSource.renamePlayer(Resident resident, String newName)
abstract boolean	TownyDataSource.saveResident(Resident resident)
boolean	TownyFlatFileSource.saveResident(Resident resident)
boolean	TownySQLSource.saveResident(Resident resident)

Method parameters in com.palmergames.bukkit.towny.db with type arguments of type Resident

Modifier and Type	Method	Description
List<UUID>	TownyDatabaseHandler.toUUIDList(Collection<Resident> residents)

Uses of Resident in com.palmergames.bukkit.towny.event

Methods in com.palmergames.bukkit.towny.event that return Resident

Modifier and Type	Method	Description
@Nullable Resident	DeleteNationEvent.getLeader()
@Nullable Resident	DeleteTownEvent.getMayor()
Resident	TownAddResidentEvent.getMayor()	If this event has been thrown by a resident starting a new town, the town will not have set their mayor yet.
Resident	PlotPreChangeTypeEvent.getResident()
Resident	RenameResidentEvent.getResident()
Resident	TownAddResidentEvent.getResident()
Resident	TownAddResidentRankEvent.getResident()
Resident	TownClaimEvent.getResident()	Gets the resident claiming the townblock.
Resident	TownPreAddResidentEvent.getResident()
Resident	TownRemoveResidentEvent.getResident()
Resident	TownRemoveResidentRankEvent.getResident()
@Nullable Resident	DeleteNationEvent.getSenderResident()
@Nullable Resident	DeleteTownEvent.getSenderResident()
@Nullable Resident	PreDeleteNationEvent.getSenderResident()
@Nullable Resident	PreDeleteTownEvent.getSenderResident()

Constructors in com.palmergames.bukkit.towny.event with parameters of type Resident

Modifier	Constructor	Description
	DeleteNationEvent(Nation nation, Resident king, DeleteNationEvent.Cause cause, org.bukkit.command.CommandSender sender)
	DeletePlayerEvent(Resident resident)
	DeleteTownEvent(@NotNull Town town, @Nullable Resident mayor, @NotNull DeleteTownEvent.Cause cause, @Nullable org.bukkit.command.CommandSender sender)
	PlotPreChangeTypeEvent(TownBlockType newType, TownBlock townBlock, Resident resident)	Changes a plot's TownBlockType
	RenameResidentEvent(String oldName, Resident resident)
	TownAddResidentEvent(Resident resident, Town town)
	TownAddResidentRankEvent(Resident resident, String rank, Town town)
	TownPreAddResidentEvent(Town town, Resident resident)
	TownRemoveResidentEvent(Resident resident, Town town)
	TownRemoveResidentRankEvent(Resident resident, String rank, Town town)

Uses of Resident in com.palmergames.bukkit.towny.event.damage

Methods in com.palmergames.bukkit.towny.event.damage that return Resident

Modifier and Type	Method	Description
@Nullable Resident	TownyPlayerDamagePlayerEvent.getAttackingResident()
@Nullable Resident	TownyPlayerDamagePlayerEvent.getVictimResident()

Uses of Resident in com.palmergames.bukkit.towny.event.deathprice

Fields in com.palmergames.bukkit.towny.event.deathprice declared as Resident

Modifier and Type	Field	Description
protected final Resident	DeathPriceEvent.deadResident

Methods in com.palmergames.bukkit.towny.event.deathprice that return Resident

Modifier and Type	Method	Description
Resident	DeathPriceEvent.getDeadResident()

Constructors in com.palmergames.bukkit.towny.event.deathprice with parameters of type Resident

Modifier	Constructor	Description
	DeathPriceEvent(Account payer, double amount, Resident deadResident, org.bukkit.entity.Player killer)
	NationPaysDeathPriceEvent(Account payer, double amount, Resident deadResident, org.bukkit.entity.Player killer, Nation nation)
	PlayerPaysDeathPriceEvent(Account payer, double amount, Resident deadResident, org.bukkit.entity.Player killer)
	TownPaysDeathPriceEvent(Account payer, double amount, Resident deadResident, org.bukkit.entity.Player killer, Town town)

Uses of Resident in com.palmergames.bukkit.towny.event.nation

Methods in com.palmergames.bukkit.towny.event.nation that return Resident

Modifier and Type	Method	Description
Resident	NationKingChangeEvent.getNewKing()
Resident	NationKingChangeEvent.getOldKing()
Resident	NationRankAddEvent.getResident()
Resident	NationRankRemoveEvent.getResident()

Constructors in com.palmergames.bukkit.towny.event.nation with parameters of type Resident

Modifier	Constructor	Description
	NationKingChangeEvent(Resident oldKing, Resident newKing)
	NationRankAddEvent(Nation nation, String rank, Resident res)
	NationRankRemoveEvent(Nation nation, String rank, Resident res)

Uses of Resident in com.palmergames.bukkit.towny.event.nation.toggle

Methods in com.palmergames.bukkit.towny.event.nation.toggle that return Resident

Modifier and Type	Method	Description
@Nullable Resident	NationToggleEvent.getResident()

Uses of Resident in com.palmergames.bukkit.towny.event.player

Methods in com.palmergames.bukkit.towny.event.player that return Resident

Modifier and Type	Method	Description
@Nullable Resident	PlayerKeepsExperienceEvent.getKiller()
@Nullable Resident	PlayerKeepsInventoryEvent.getKiller()
Resident	PlayerKilledPlayerEvent.getKillerRes()
@Nullable Resident	PlayerEntersIntoDistrictEvent.getResident()
@Nullable Resident	PlayerEntersIntoTownBorderEvent.getResident()
@Nullable Resident	PlayerExitsFromDistrictEvent.getResident()
@Nullable Resident	PlayerExitsFromTownBorderEvent.getResident()
Resident	PlayerKeepsExperienceEvent.getResident()
Resident	PlayerKeepsInventoryEvent.getResident()
Resident	PlayerKilledPlayerEvent.getVictimRes()

Constructors in com.palmergames.bukkit.towny.event.player with parameters of type Resident

Modifier	Constructor	Description
	PlayerKilledPlayerEvent(org.bukkit.entity.Player killer, org.bukkit.entity.Player victim, Resident killerRes, Resident victimRes, org.bukkit.Location location, org.bukkit.event.entity.PlayerDeathEvent event)	An event fired from a EventPriority.MONITOR listener.

Uses of Resident in com.palmergames.bukkit.towny.event.plot

Methods in com.palmergames.bukkit.towny.event.plot that return Resident

Modifier and Type	Method	Description
Resident	PlayerChangePlotTypeEvent.getResident()
@NotNull Resident	PlotNotForSaleEvent.getResident()
@NotNull Resident	PlotSetForSaleEvent.getResident()
Resident	PlotTrustAddEvent.getTrustedResident()
Resident	PlotTrustRemoveEvent.getTrustedResident()

Constructors in com.palmergames.bukkit.towny.event.plot with parameters of type Resident

Modifier	Constructor	Description
	PlotNotForSaleEvent(Resident resident, TownBlock townBlock)
	PlotSetForSaleEvent(Resident resident, double price, TownBlock townBlock)
	PlotTrustAddEvent(TownBlock townBlock, Resident trustedResident, org.bukkit.entity.Player player)
	PlotTrustAddEvent(List<TownBlock> townBlocks, Resident trustedResident, org.bukkit.entity.Player player)
	PlotTrustRemoveEvent(TownBlock townBlock, Resident trustedResident, org.bukkit.entity.Player player)
	PlotTrustRemoveEvent(List<TownBlock> townBlocks, Resident trustedResident, org.bukkit.entity.Player player)

Uses of Resident in com.palmergames.bukkit.towny.event.plot.changeowner

Methods in com.palmergames.bukkit.towny.event.plot.changeowner that return Resident

Modifier and Type	Method	Description
@Nullable Resident	PlotChangeOwnerEvent.getNewResident()
@Nullable Resident	PlotChangeOwnerEvent.getOldResident()

Constructors in com.palmergames.bukkit.towny.event.plot.changeowner with parameters of type Resident

Modifier	Constructor	Description
	PlotChangeOwnerEvent(@Nullable Resident oldResident, @Nullable Resident newResident, @NotNull TownBlock townBlock)
	PlotClaimEvent(Resident oldResident, Resident newResident, TownBlock townBlock)
	PlotPreClaimEvent(Resident oldResident, Resident newResident, TownBlock townBlock)
	PlotPreUnclaimEvent(Resident oldResident, Resident newResident, TownBlock townBlock)
	PlotUnclaimEvent(Resident oldResident, Resident newResident, TownBlock townBlock)

Uses of Resident in com.palmergames.bukkit.towny.event.resident

Methods in com.palmergames.bukkit.towny.event.resident that return Resident

Modifier and Type	Method	Description
Resident	NewResidentEvent.getResident()
Resident	ResidentJailEvent.getResident()
Resident	ResidentPreJailEvent.getResident()
Resident	ResidentToggleModeEvent.getResident()
Resident	ResidentUnjailEvent.getResident()

Constructors in com.palmergames.bukkit.towny.event.resident with parameters of type Resident

Modifier	Constructor	Description
	NewResidentEvent(Resident resident)
	ResidentJailEvent(Resident resident, JailReason reason, org.bukkit.entity.Player sender)
	ResidentPreJailEvent(Resident resident, Jail jail, int cell, int hours, double bail, JailReason reason)
	ResidentToggleModeEvent(Resident resident, String mode)
	ResidentUnjailEvent(Resident resident, UnJailReason reason)

Uses of Resident in com.palmergames.bukkit.towny.event.statusscreen

Methods in com.palmergames.bukkit.towny.event.statusscreen that return Resident

Modifier and Type	Method	Description
Resident	ResidentStatusScreenEvent.getResident()

Constructors in com.palmergames.bukkit.towny.event.statusscreen with parameters of type Resident

Modifier	Constructor	Description
	ResidentStatusScreenEvent(StatusScreen screen, Resident resident)

Uses of Resident in com.palmergames.bukkit.towny.event.teleport

Methods in com.palmergames.bukkit.towny.event.teleport that return Resident

Modifier and Type	Method	Description
Resident	OutlawTeleportEvent.getOutlaw()
Resident	CancelledTownyTeleportEvent.getResident()
Resident	SuccessfulTownyTeleportEvent.getResident()
Resident	UnjailedResidentTeleportEvent.getResident()

Constructors in com.palmergames.bukkit.towny.event.teleport with parameters of type Resident

Modifier	Constructor	Description
	CancelledTownyTeleportEvent(Resident resident, org.bukkit.Location location, double teleportCost, CancelledTownyTeleportEvent.CancelledTeleportReason reason)
	OutlawTeleportEvent(Resident outlaw, Town town, org.bukkit.Location loc)
	SuccessfulTownyTeleportEvent(Resident resident, org.bukkit.Location loc, double cost)
	UnjailedResidentTeleportEvent(Resident resident, org.bukkit.Location location)

Uses of Resident in com.palmergames.bukkit.towny.event.town

Methods in com.palmergames.bukkit.towny.event.town that return Resident

Modifier and Type	Method	Description
Resident	TownPreInvitePlayerEvent.getInvitedResident()	Convenience method for getting the resident that was invited.
Resident	TownKickEvent.getKickedResident()
Resident	TownMayorChangedEvent.getNewMayor()
Resident	TownMayorChangeEvent.getNewMayor()
Resident	TownMayorChosenBySuccessionEvent.getNewMayor()
Resident	TownMayorChangedEvent.getOldMayor()
Resident	TownMayorChangeEvent.getOldMayor()
Resident	TownMayorChosenBySuccessionEvent.getOldMayor()
Resident	TownOutlawAddEvent.getOutlawedResident()
Resident	TownOutlawRemoveEvent.getOutlawedResident()
Resident	TownLeaveEvent.getResident()
Resident	TownPreReclaimEvent.getResident()
Resident	TownPreRemoveResidentEvent.getResident()
Resident	TownPreUnclaimCmdEvent.getResident()
Resident	TownReclaimedEvent.getResident()	The resident who is reclaiming the town, and will become the new mayor.
Resident	TownTrustAddEvent.getTrustedResident()
Resident	TownTrustRemoveEvent.getTrustedResident()

Methods in com.palmergames.bukkit.towny.event.town that return types with arguments of type Resident

Modifier and Type	Method	Description
@Nullable List<Resident>	TownMayorChosenBySuccessionEvent.getPotentialMayors()

Methods in com.palmergames.bukkit.towny.event.town with parameters of type Resident

Modifier and Type	Method	Description
void	TownMayorChosenBySuccessionEvent.setNewMayor(Resident replacementMayor)

Constructors in com.palmergames.bukkit.towny.event.town with parameters of type Resident

Modifier	Constructor	Description
	TownKickEvent(Resident kickedResident, Object kicker)
	TownLeaveEvent(Resident resident, Town town)
	TownMayorChangedEvent(Resident oldMayor, Resident newMayor)
	TownMayorChangeEvent(org.bukkit.command.CommandSender sender, Resident oldMayor, Resident newMayor)
	TownMayorChosenBySuccessionEvent(Resident oldMayor, Resident newMayor, List<Resident> potentialResidents)
	TownOutlawAddEvent(org.bukkit.command.CommandSender sender, Resident outlawedResident, Town town)
	TownOutlawRemoveEvent(org.bukkit.command.CommandSender sender, Resident outlawedResident, Town town)
	TownPreReclaimEvent(Town town, Resident resident, org.bukkit.entity.Player player)	Event thrown prior to a Town being reclaimed by a Resident.
	TownPreRemoveResidentEvent(Resident resident, Town town)
	TownPreUnclaimCmdEvent(Town town, Resident resident, TownyWorld world, List<WorldCoord> selection)	Constructs the TownPreUnclaimCmdEvent and stores data an external war plugin may use.
	TownReclaimedEvent(Town town, Resident resident)
	TownTrustAddEvent(org.bukkit.command.CommandSender sender, Resident trustedResident, Town town)
	TownTrustRemoveEvent(org.bukkit.command.CommandSender sender, Resident trustedResident, Town town)

Constructor parameters in com.palmergames.bukkit.towny.event.town with type arguments of type Resident

Modifier	Constructor	Description
	TownMayorChosenBySuccessionEvent(Resident oldMayor, Resident newMayor, List<Resident> potentialResidents)

Uses of Resident in com.palmergames.bukkit.towny.event.town.toggle

Methods in com.palmergames.bukkit.towny.event.town.toggle that return Resident

Modifier and Type	Method	Description
@Nullable Resident	TownToggleEvent.getResident()

Uses of Resident in com.palmergames.bukkit.towny.listeners

Methods in com.palmergames.bukkit.towny.listeners with parameters of type Resident

Modifier and Type	Method	Description
boolean	TownyPlayerListener.blockCommandInsideTown(org.bukkit.entity.Player player, Resident resident, TownBlock townBlock, String command)	Allows restricting commands while being in a town.
boolean	TownyPlayerListener.blockJailedPlayerCommand(org.bukkit.entity.Player player, Resident resident, String command)
boolean	TownyPlayerListener.blockOutlawedPlayerCommand(org.bukkit.entity.Player player, Resident resident, TownBlock townBlock, String command)	Blocks outlawed players using blacklisted commands.
boolean	TownyPlayerListener.blockWarPlayerCommand(org.bukkit.entity.Player player, Resident resident, String command)

Uses of Resident in com.palmergames.bukkit.towny.object

Methods in com.palmergames.bukkit.towny.object that return Resident

Modifier and Type	Method	Description
Resident	Nation.getKing()
Resident	Town.getMayor()
@Nullable Resident	PlotGroup.getResident()
Resident	TownBlock.getResident()
@Nullable Resident	TownBlock.getResidentOrNull()	Relatively safe to use after testing TownBlock.hasResident().

Methods in com.palmergames.bukkit.towny.object that return types with arguments of type Resident

Modifier and Type	Method	Description
List<Resident>	Nation.getAssistants()
List<Resident>	Resident.getFriends()
List<Resident>	Town.getJailedResidents()
Collection<Resident>	Nation.getOutlaws()
Collection<Resident>	ResidentList.getOutlaws()	Gets the unmodifiable list of outlaws.
Collection<Resident>	Town.getOutlaws()
Map<Resident,PermissionData>	PlotGroup.getPermissionOverrides()
Map<Resident,PermissionData>	TownBlock.getPermissionOverrides()
List<Resident>	Town.getRank(String rank)
List<Resident>	Nation.getResidents()
Collection<Resident>	ResidentList.getResidents()	Returns an unmodifiable list of residents.
List<Resident>	Town.getResidents()
Set<Resident>	PlotGroup.getTrustedResidents()
Set<Resident>	Town.getTrustedResidents()
Set<Resident>	TownBlock.getTrustedResidents()

Methods in com.palmergames.bukkit.towny.object with parameters of type Resident

Modifier and Type	Method	Description
void	Resident.addFriend(Resident resident)
void	Town.addOutlaw(Resident resident)
void	Town.addOutlawCheck(Resident resident)
void	Town.addResidentCheck(Resident resident)
void	PlotGroup.addTrustedResident(Resident resident)
void	Town.addTrustedResident(Resident resident)
void	TownBlock.addTrustedResident(Resident resident)
final void	Government.depositToBank(Resident resident, int amount)	Puts money into the bank.
void	Town.forceSetMayor(Resident mayor)	Sets a resident to become mayor.
String	Translatable.forLocale(Resident resident)
static Locale	Translation.getLocale(Resident resident)
boolean	Nation.hasAssistant(Resident resident)
boolean	Resident.hasFriend(Resident resident)
boolean	Town.hasOutlaw(Resident outlaw)
boolean	Nation.hasResident(Resident resident)
boolean	Town.hasResident(Resident resident)
boolean	TownBlock.hasResident(Resident resident)
boolean	Town.hasResidentWithRank(Resident resident, String rank)
boolean	PlotGroup.hasTrustedResident(Resident resident)
boolean	Town.hasTrustedResident(Resident resident)
boolean	TownBlock.hasTrustedResident(Resident resident)
boolean	Resident.isAlliedWith(Resident otherresident)
boolean	Nation.isKing(Resident resident)
boolean	Town.isMayor(Resident resident)
Translatable	Translatable.locale(@NotNull Resident resident)
static String	Translation.of(String key, Resident resident)
static String	Translation.of(String key, Resident resident, Object... args)
void	PlotGroup.putPermissionOverride(Resident resident, PermissionData permissionData)
void	Resident.removeFriend(Resident resident)
void	Town.removeOutlaw(Resident resident)
void	PlotGroup.removePermissionOverride(Resident resident)
void	Town.removeResident(Resident resident)
void	PlotGroup.removeTrustedResident(Resident resident)
void	Town.removeTrustedResident(Resident resident)
void	TownBlock.removeTrustedResident(Resident resident)
void	Nation.setKing(Resident king)
void	Town.setMayor(Resident mayor)	Sets a town resident to become mayor.
void	Town.setMayor(Resident mayor, boolean callEvent)
void	PlotGroup.setResident(Resident resident)
boolean	TownBlock.setResident(@Nullable Resident resident)	Changes the owner of the plot to the given resident.
boolean	TownBlock.setResident(@Nullable Resident resident, boolean callEvent)	Changes the owner of the plot to the given resident.
void	TownBlock.setType(TownBlockType type, Resident resident)
void	TownBlock.testTownMembershipAgePreventsThisClaimOrThrow(Resident resident)	Tests whether a Resident's Town membership age (join date) is too high or low, preventing them from claiming this TownBlock personally with /plot claim.
void	TownyInventory.tryPaginate(org.bukkit.inventory.ItemStack clickedItem, org.bukkit.entity.Player player, Resident resident, org.bukkit.inventory.InventoryView inventoryView)
final void	Government.withdrawFromBank(Resident resident, int amount)	Takes money from the bank.

Method parameters in com.palmergames.bukkit.towny.object with type arguments of type Resident

Modifier and Type	Method	Description
void	TownBlock.addTrustedResidents(List<Resident> residents)
void	Town.loadOutlaws(List<Resident> outlaws)
void	Resident.setFriends(List<Resident> newFriends)
void	PlotGroup.setPermissionOverrides(Map<Resident,PermissionData> permissionOverrides)
void	TownBlock.setPermissionOverrides(Map<Resident,PermissionData> permissionOverrides)
void	PlotGroup.setTrustedResidents(Set<Resident> trustedResidents)
void	TownBlock.setTrustedResidents(Set<Resident> trustedResidents)

Constructors in com.palmergames.bukkit.towny.object with parameters of type Resident

Modifier	Constructor	Description
protected	EconomyAccount(Resident resident, String name, UUID uuid, Supplier<TownyWorld> worldSupplier)
	TownyInventory(Resident res, org.bukkit.inventory.Inventory inv, String name)

Uses of Resident in com.palmergames.bukkit.towny.object.gui

Methods in com.palmergames.bukkit.towny.object.gui with parameters of type Resident

Modifier and Type	Method	Description
void	PermissionGUI.tryPaginate(org.bukkit.inventory.ItemStack clickedItem, org.bukkit.entity.Player player, Resident resident, org.bukkit.inventory.InventoryView inventoryView)

Constructors in com.palmergames.bukkit.towny.object.gui with parameters of type Resident

Modifier	Constructor	Description
	EditGUI(Resident res, org.bukkit.inventory.Inventory inv, String name, TownBlock townBlock, Resident selectedResident)
	PermissionGUI(Resident res, org.bukkit.inventory.Inventory inv, String name, TownBlock townBlock, boolean canEdit)
	SelectionGUI(Resident res, org.bukkit.inventory.Inventory inv, String name, SelectionGUI.SelectionType type)

Uses of Resident in com.palmergames.bukkit.towny.object.inviteobjects

Constructors in com.palmergames.bukkit.towny.object.inviteobjects with parameters of type Resident

Modifier	Constructor	Description
	PlayerJoinTownInvite(org.bukkit.command.CommandSender directSender, Resident receiver, Town sender)

Uses of Resident in com.palmergames.bukkit.towny.object.resident.mode

Methods in com.palmergames.bukkit.towny.object.resident.mode with parameters of type Resident

Modifier and Type	Method	Description
protected static void	ResidentModeHandler.addMode(Resident resident, AbstractResidentMode mode)
static void	ResidentModeHandler.applyDefaultModes(Resident resident, boolean notify)
static void	ResidentModeHandler.clearModes(Resident resident, boolean notify)	Removes all modes from a Resident.
static Set<AbstractResidentMode>	ResidentModeHandler.getModes(Resident resident)
protected static Set<AbstractResidentMode>	ResidentModeHandler.getResidentModes(Resident resident)
static List<String>	ResidentModeHandler.getResidentModesNames(Resident resident)
static boolean	ResidentModeHandler.hasMode(Resident resident, AbstractResidentMode mode)
static boolean	ResidentModeHandler.hasMode(Resident resident, String name)
protected static void	ResidentModeHandler.removeMode(Resident resident, AbstractResidentMode mode)
static void	ResidentModeHandler.resetModes(Resident resident, boolean notify)	Removes all modes from a Resident and then resets their modes to the Default Modes according to their permissions.
protected abstract void	AbstractResidentMode.toggle(Resident resident)
protected void	BorderResidentMode.toggle(Resident resident)
protected void	ClaimingResidentMode.toggle(Resident resident)
protected void	GenericResidentMode.toggle(Resident resident)
static void	ResidentModeHandler.toggleMode(Resident resident, AbstractResidentMode mode, boolean notify)	Will attempt to toggle on or off, a AbstractResidentMode on a Resident.
static void	ResidentModeHandler.toggleMode(Resident resident, String name, boolean notify)	Will attempt to toggle on or off, a named mode on a Resident.
static void	ResidentModeHandler.toggleModes(Resident resident, String[] names, boolean notify, boolean clearModes)	Will clear a Resident's modes and then apply all of the given named Modes.

Uses of Resident in com.palmergames.bukkit.towny.permissions

Methods in com.palmergames.bukkit.towny.permissions with parameters of type Resident

Modifier and Type	Method	Description
static void	TownyPerms.assignPermissions(Resident resident, org.bukkit.entity.Player player)	Register a specific residents permissions with Bukkit.
static String	TownyPerms.getHighestPriorityRank(Resident resident, List<String> ranks, Function<String,List<String>> rankFunction)
String	BukkitPermSource.getPrefixSuffix(Resident resident, String node)
String	GroupManagerSource.getPrefixSuffix(Resident resident, String node)	getPermissionNode returns the specified prefix/suffix nodes from GroupManager
String	NullPermSource.getPrefixSuffix(Resident resident, String node)
abstract String	TownyPermissionSource.getPrefixSuffix(Resident resident, String node)
String	VaultPermSource.getPrefixSuffix(Resident resident, String node)
static LinkedHashMap<String,Boolean>	TownyPerms.getResidentPerms(Resident resident)	Returns a sorted map of this residents current permissions.
static String	TownyPerms.getResidentPrimaryRankPrefix(Resident resident)

Uses of Resident in com.palmergames.bukkit.towny.tasks

Methods in com.palmergames.bukkit.towny.tasks with parameters of type Resident

Modifier and Type	Method	Description
static boolean	TeleportWarmupTimerTask.abortTeleportRequest(@Nullable Resident resident)	Aborts the current active teleport request for the given resident.
static boolean	TeleportWarmupTimerTask.abortTeleportRequest(@Nullable Resident resident, CancelledTownyTeleportEvent.CancelledTeleportReason reason)	Aborts the current active teleport request for the given resident.
static TeleportRequest	TeleportWarmupTimerTask.getTeleportRequest(@NotNull Resident resident)
static boolean	TeleportWarmupTimerTask.hasTeleportRequest(@NotNull Resident resident)
static void	TeleportWarmupTimerTask.requestTeleport(@NotNull Resident resident, @NotNull org.bukkit.Location destination, int cooldown, @Nullable Account teleportAccount, double teleportCost)	This does not refund any other teleport requests that might be active for the resident, use TeleportWarmupTimerTask.abortTeleportRequest(Resident) first if you want them to be refunded.
static void	TeleportWarmupTimerTask.requestTeleport(Resident resident, org.bukkit.Location spawnLoc)
static void	TeleportWarmupTimerTask.requestTeleport(Resident resident, org.bukkit.Location spawnLoc, int cooldown)

Constructors in com.palmergames.bukkit.towny.tasks with parameters of type Resident

Modifier	Constructor	Description
	PlotClaim(Towny plugin, org.bukkit.entity.Player player, Resident resident, List<WorldCoord> selection, boolean claim, boolean admin, boolean groupClaim)

Uses of Resident in com.palmergames.bukkit.towny.utils

Methods in com.palmergames.bukkit.towny.utils that return Resident

Modifier and Type	Method	Description
static Resident	ResidentUtil.createAndGetNPCResident()

Methods in com.palmergames.bukkit.towny.utils that return types with arguments of type Resident

Modifier and Type	Method	Description
static List<Resident>	TownUtil.gatherInactiveResidents(List<Resident> resList, int days)	Makes a list of Residents who haven't logged in in the given days.
static List<Resident>	ResidentUtil.getOnlineResidentsViewable(org.bukkit.entity.Player viewer, ResidentList residentList)	Return a list of Residents that can be seen (not vanished) by the viewer.
static List<Resident>	ResidentUtil.getValidatedResidents(org.bukkit.command.CommandSender sender, List<String> names)	Transforms a String[] of names to a list of Residents.
static List<Resident>	ResidentUtil.getValidatedResidentsOfTown(org.bukkit.command.CommandSender sender, Town town, String[] names)	Transforms a String[] of names to a list of Residents.

Methods in com.palmergames.bukkit.towny.utils with parameters of type Resident

Modifier and Type	Method	Description
static List<WorldCoord>	AreaSelectionUtil.filterOutResidentBlocks(Resident resident, List<WorldCoord> selection)	Returns a List containing only claimed townblocks, which are: - not personally owned by a resident who isn't the given resident
static List<WorldCoord>	AreaSelectionUtil.filterPlotsForSale(Resident resident, List<WorldCoord> selection)	Gather plots that are for sale only, using a resident to determine whether they can be bought.
static boolean	CombatUtil.isAlly(Resident a, Resident b)	Is the resident B an ally of resident A?
static boolean	CombatUtil.isEnemy(Resident a, Resident b)	Is the resident B an enemy of resident A?
static boolean	JailUtil.isQueuedToBeJailed(Resident resident)
static boolean	CombatUtil.isSameNation(Resident a, Resident b)	Is resident a in a nation with resident b?
static boolean	CombatUtil.isSameTown(Resident a, Resident b)	Is resident a in a town with resident b?
static void	SpawnUtil.jailAwayTeleport(Resident jailed)	Used to teleport a jailed resident away from jail, upon gaining freedom.
static void	JailUtil.jailResident(Resident resident, Jail jail, int cell, int hours, JailReason reason, org.bukkit.command.CommandSender jailer)	Jails a resident.
static void	JailUtil.jailResidentWithBail(Resident resident, Jail jail, int cell, int hours, double bail, JailReason reason, org.bukkit.command.CommandSender jailer)	Jails a resident.
static void	SpawnUtil.jailTeleport(Resident jailed)	Used to teleport a newly jailed resident to jail.
static void	MoneyUtil.nationDeposit(org.bukkit.entity.Player player, Resident resident, Nation nation, int amount)
static void	MoneyUtil.nationWithdraw(org.bukkit.entity.Player player, Resident resident, Nation nation, int amount)
static void	ResidentUtil.openGUIInventory(Resident resident, Collection<org.bukkit.Material> set, String name)
static void	ResidentUtil.openGUIInventory(Resident resident, List<String> list, String name)	Opens a basic inventory GUI with pagination.
static void	PermissionGUIUtil.openPermissionEditorGUI(@NotNull Resident resident, @NotNull TownBlock townBlock, @NotNull org.bukkit.inventory.ItemStack clickedItem)
static void	PermissionGUIUtil.openPermissionGUI(@NotNull Resident resident, @NotNull TownBlock townBlock)
static void	ResidentUtil.openSelectionGUI(Resident resident, SelectionGUI.SelectionType selectionType)
static void	ResidentUtil.outlawEnteredTown(Resident outlaw, Town town, org.bukkit.Location location)	Method which will teleport an outlaw out of a town, if the player does not have the bypass node and the outlaw teleport feature is active.
static void	SpawnUtil.outlawTeleport(Town town, Resident outlaw)	Handles moving outlaws from outside of towns they are outlawed in.
static boolean	OutpostUtil.OutpostTests(Town town, Resident resident, TownyWorld world, Coord key, boolean isAdmin, boolean isPlotSetOutpost)	Checks to make sure all requirements are met before an outpost can be claimed.
static void	TownRuinUtil.reclaimTown(@NotNull Resident resident, @NotNull Town town)
static void	ChunkNotificationUtil.showChunkNotification(org.bukkit.entity.Player player, Resident resident, WorldCoord to, WorldCoord from)
static void	ResidentUtil.toggleResidentBorderTitles(Resident resident, Optional<Boolean> choice)
static void	MoneyUtil.townDeposit(org.bukkit.entity.Player player, Resident resident, Town town, Nation nation, int amount)
static void	MoneyUtil.townWithdraw(org.bukkit.entity.Player player, Resident resident, Town town, int amount)
static void	JailUtil.unJailResident(Resident resident)
static void	JailUtil.unJailResident(Resident resident, UnJailReason reason)	Unjails a resident.

Method parameters in com.palmergames.bukkit.towny.utils with type arguments of type Resident

Modifier and Type	Method	Description
static boolean	CombatUtil.areAllFriends(List<Resident> possibleFriends)	Test if all the listed residents are friends
static List<Resident>	TownUtil.gatherInactiveResidents(List<Resident> resList, int days)	Makes a list of Residents who haven't logged in in the given days.

Uses of Resident in com.palmergames.bukkit.util

Methods in com.palmergames.bukkit.util with parameters of type Resident

Modifier and Type	Method	Description
static org.bukkit.Color	DrawSmokeTaskFactory.getAffiliationColor(Resident resident, WorldCoord coord)