All Classes and Interfaces
Class
Description
Used to facilitate transactions regarding money,
and the storage of funds.
A class which facilitates the observance
of transactions within economy accounts.
A variant of an
Account that belongs to a Government.Defines methods necessary for the operation of a bank.
Called whenever a deposit or withdrawl is made to/from a Bank account
associated with a Town or Nation.
Called when a
Player tries to set their spawn point at a bed or respawn anchor in a dimension that doesn't support them.A class to hold basic block location data
Overriding this event you can use custom formulas to set bonus block purchase price
A class of functions related to Bukkit in general.
A class extended by Towny Events which are Cancellable and which contain a
cancelMessage.
An event thrown by Towny when a player that was supposed to teleport to the
/res, /town, or /nation spawn, but the action was cancelled.
Represents a read changelog from a
ChangelogReader.Useful function for use with the Minecraft Server chatbox.
Task run in Async which deletes old backups
and other outdated things.
An object which manages the process of migrating towny config versions to
up-to-date ones.
An object which stores information about confirmations.
A class responsible for assembling confirmations.
Called after a
Confirmation is successfully cancelled, either due to timing out or due to the sender cancelling it manually.Called when a
Confirmation is confirmed using /confirm.A class that handles the processing confirmations sent in Towny.
Called when a
Confirmation is about to be sent to a CommandSenderA class to hold and calculate coordinates in a grid according to the size
defined in
the static field size.
Functional interface for deserializing a specific CustomDataField class.
Called when a townblock is added into a district
Called when a district is created.
An Account object representing a Player's account.
An adapter that is used to adapt multiple
economy implementations.
An interface used to show that an object is capable of participating
in economy specific tasks.
A class which performs audits on ALL account transactions.
A class which represents the structure of objects that
occupy areas or interactive managed sub-objects.
A list of static comparators used for organizing lists of
Government'sThis class represents the hourly timer task
It is generally set to run once per hour
This rate can be configured.
All classes that implement this interface
are uniquely identifiable by a UUID.
An object that represents an invitation.
A class that only serves as a name-spacing class.
Represents a class that can receive invitations.
Represents a class that can receive invitations.
Item lists as Strings.
Called when Towny has finished deserializing all metadata.
A simple interface to show that a class can be named, agnostic
if its a
TownyObject or not.A helper class to extract name data from classes and filter matching strings.
Event called whenever nation bonus blocks are being fetched.
An event that is thrown which allows other plugins to alter a Nation's
NationLevel Number. ie: 1 to
TownySettings.getNationLevelMax().A list of static comparators used for organizing lists of
Nation'sEvent that gets fired when a nation's king changes.
Cancellable event that gets fired before a town is invited to a nation.
An Cancellable event thrown when a
Nation BankAccount is
about to either receive or pay money.Fired when a player uses /nation set spawn
An event called when nation spawns occur.
An event thrown when a
Nation BankAccount either receives or
pays money.An abstract class which defines the mechanics of groups in towny.
A class used to show permission capability.
Groups all the cache status and permissions in one place.
Author: Chris H (Zren / Shade)
Date: 4/15/12
Thrown when a player crosses into Town border.
Thrown when a player crosses into Town border.
Send a list of all general towny plot help commands to player Command: /plot
Called when a townblock is added into a plot group
Called when a plot group is created.
Created by Glare
Date: 12/15/2020
Time: 6:48 AM
Created by Glare
Date: 12/15/2020
Time: 6:39 AM
This event is called before the new day operations are executed in DailyTimerTask.
A conversation that is used for getting resident input via chat.
Represents an object capable of storing residents within it.
An event called when /res spawn occurs.
Basic interface that depicts whether an object has a specified save method.
A GUI used for selecting
A util for Shop Plugin Developers to use,
given the player and location, the Util will return true if the
player should be able to create a shop at the given location.
This class represents the short timer task
It is generally set to run about once per 20 seconds
This rate can be configured.
A class which provides the basis for spawn events.
This is an internal class used by towny to pass-around info related to spawning
Provides the spawn location and access to setter for spawn locations.
A worldname, x, y, z location used to validate SpawnPoints.
Useful functions related to strings, or arrays of them.
Thrown when Towny teleports a player after they have used /res, /town, or
/nation spawn.
Author: Chris H (Zren / Shade)
Date: 5/23/12
Fired after a resident has been added to a town.
Overriding this event you can use custom formulas to set town block claim price
An event thrown when Towny will determine the explosion status of
a townblock, or plot, in a town.
Allows objects to contain townblocks to be accessed/manipulated.
An event thrown when Towny will determine the PVP status of
a townblock, or plot, in a town.
An event that is thrown which allows other plugins to alter a Town's
TownLevel Number. ie: 1 to
TownySettings.getTownLevelMax().Send a list of all town help commands to player Command: /town
A list of static comparators used for organizing lists of
Town'sAn event thrown when a
Town becomes bankrupt.Event that gets fired when a resident gets kicked from a town.
Used to alter how many residents a town appears to have in the /town list pages.
Event called whenever the town's *local* map colour is being retrieved.
Event called whenever the town's *national* map-colour is being retrieved.
Event that gets fired when a town's mayor has changed.
A Cancellable Event that gets fired when a town's mayor changes by a player
using an in-game command.
Event that gets fired when a town has had their mayor removed by Towny,
resulting in Towny choosing a Town resident to become mayor.
Runs before town banks are charged
Provides raw town block
Cancellable event that gets fired before a resident is invited to a town.
Fired before a resident has been removed from a town.
An event which is fired before Towny puts a Town into a ruined status.
An Cancellable event thrown when a
Town BankAccount is about
to either receive or pay money.An event fired when a '/town unclaim [args]' command is issued, prior to any
other calculations.
Author: Chris H (Zren / Shade)
Date: 5/23/12
Fired after a resident has been removed from a town.
This class contains utility functions related to ruins
Fired when a player uses /town set outpost
Fired when a player uses /town set spawn
An event called when town spawns occur.
An event thrown when a
Town BankAccount either receives or
pays money.This event fires after a TownBlock has been unclaimed and stores the
WorldCoordMain class for Towny
Used by the TownyBuildEvent, TownyDestroyEvent, TownySwitchEvent
and TownyItemuseEvent.
An executor class used to check the internal Towny PlayerCache and then
launch the ActionType-based Towny Events.
Send a list of all general townyadmin help commands to player Command:
/townyadmin
Towny's class for external API Methods
For more dynamic/controlled changing of Towny's behavior, for example Database, War, Permissions
The
TownyUniverse class should be used.Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Internal utility class for common interactions with adventure components.
Author: Chris H (Zren / Shade)
Date: 4/15/12
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Economy handler to interface with Register or Vault directly.
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Exception thrown when Towny fails to initialize.
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Object that is used to cache information used to display
the Towny ASCII Map.
Towny message handling class
A class that represents a permission change to a town block owner.
This class will be registered through the register-method in the plugins
onEnable-method.
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Handle events for all Player related events
Players deaths are handled both here and in the TownyEntityMonitorListener
An Cancellable event thrown when any
Transaction is about to occur
because of Towny.For internal use only.
Part of the API which lets Towny's war and other plugins modify Towny's
plot-permission-decision outcomes.
Handler for all running timers
An event thrown when any
Transaction has occured because of Towny.Towny's class for internal API Methods
If you don't want to change the dataSource, war, permissions or similar behavior
and only for example want to get Resident objects you should use
TownyAPIHandle events for all Vehicle related events
Deprecated.
Deprecated.
since 0.100.4.0 use
TransactionType instead.A convenience object to facilitate translation.
Dynamic trie structure that can add/remove keys and recursively get matching strings for a key
TrieNode implementation that handles any character and keeps track of its own children and character
Represents a numbering system of a string format.
An event thrown when Towny will determine the PVP status of
the wilderness surrounding town-owned land.
Transactioninstead.