TownBlockStatus
An explanation of the many types of TownBlockStatus, as deduced from the Towny source code (specifically a rundown of the TownBlockStatus enum defined in PlayerCache, and given by getTownBlockStatus in PlayerCacheUtil). There was no explanation of any of these given anywhere, so here is what I deduced. If you want to change what plots the notification triggers in, you will need to know these.
TownBlockStatus is the state of the town block in respect to a player stood in that block.
In the following table, "resident" is the player being considered, "town block" is the town block the resident is stood in, and "owner" is the resident who owns that town block. The table is ordered in the order of prevalence of the statuses. The Config Option column states which option in the configuration represents that town block status, and the Default column gives the default value that option has - see here for more.
| Status | Meaning | Config Option | Default |
|---|---|---|---|
| UNKOWN | Unknown status - initial assignment before the status is actually calculated. Should not ever actually be passed to TownyNotifier - NOT_REGISTERED will probably happen first. Misspelled in source. Unwise to change from false - included for completion. | unknown | false |
| OFF_WORLD | Resident is on world on the server that Towny does not manage (e.g. a separate creative world, or a map-based PVP world, etc) - set using /townyworld toggle usingtowny or by editing a Towny config file. You probably do not want to change this from false unless you have a good reason to. | offworld | false |
| NOT_REGISTERED | There was an issue with the world or resident (one of them could not be registered correctly; an exception was thrown). Unwise to change from false - included for completion. | notregistered | false |
| UNCLAIMED_ZONE | Resident is stood in a town block not yet claimed by any town - the wilderness. | unclaimed | false |
| LOCKED | A plot that has been locked by Towny. This occurs when the plot's status has been changed too much in a short time, and expires after some time has passed or server restarted. | locked | false |
| WARZONE | Resident is stood in any part of any nation, resident's town is part of a nation, and a war is ongoing. Also includes outsiders when nationless towns are allowed in the war. | warzone | false |
| TOWN_OWNER | Resident is mayor of the town which the town block is a part of. | townowner | false |
| PLOT_OWNER | Resident is owner of the town block. | plotowner | false |
| PLOT_FRIEND | Resident is on the owner's friend list. | plotfriend | false |
| PLOT_ALLY | Resident's and owner's towns are allies. Also applies when resident and owner are part of the same town. | plotally | true |
| OUTSIDER | Resident is not part of the town which the town block belongs to, resident's town is not an ally of the town, and resident is not a friend of owner. | outsider | true |
| TOWN_ALLY | Resident is stood in a town block of an allied town, and the town block is not owned by a player (i.e. an unclaimed or for sale plot). Unlike PLOT_ALLY, does not include the same town. | townally | true |
| ENEMY | Resident is stood in an enemy town, when not at war. | enemy | true |
| TOWN_RESIDENT | Resident is stood in a town block of their town, and the town block is not owned by a player (i.e. an unclaimed or for sale plot). | townresident | true |
Comments