Regionkinds & RegionkindGroups
Regionkinds and RegionkindGroups can be assigned to your regions to group them together and bring them into a context. Regionkinds and RegionkindGroups bring multiple advantages:
- Show a different item in the GUI depending on the Regionkinds. (
/arm gui) - Find free regions that belong to a specific Regionkind in the regionfinder. (
/arm regionfinder) - Limit the number of regions a player is allowed to own, belonging to a specific Regionkind or RegionkindGroup. (
/arm limit) - Find out how many regions of a specific regionkind are currently in use or for sale. (
/arm regionstats)
Imagine the following scenario: There is a server with many regions. Some of them are user-shops. User-shops can be large or small. Others are city-plots for the players to build on. These city-plots are further separated into starter-plots, regular-plots, skyscraper-plots and vip-plots. The following configuration would make sense:
Create the Regionkinds: small-shop, large-shop, starter, regular, skyscraper and vip.
Add the RegionkindGroups: shop, city-plot.
Now add the Regionkinds small-shop and large-shop to the RegionkindGroup shop and add the Regionkinds starter, regular and skyscraper to the RegionkindGroup city-plot.
It would now be possible for players to use the regionfinder to search for a small-shop region or a stater-plot. It would be possible to give out free starter-regions and limit the players to only own a single one of these regions. It would also be possible to limit the number or regions a player is allowed to own based on a RegionKindGroup. One could for example say that players are only allowed to own three city-plots. But they can decide how to spread their limits on the regionkinds starter-plot, regular-plot and skyscraper-plot.
In theory it would also be possible to assign multiple RegionkindGroups to a single RegionKind, which would allow even more complex limit scenarios.
When printing the info of a region using /arm info <regionId>, the RegionKind and the corresponding RegionKindGroups are shown to the user:
This article only covers how to setup RegionKind and RegionKindGroups. To lean more about configuring limit click here: https://github.com/alex9849/advanced-region-market/wiki/Limits
Creating a Regionkind:
Command: /arm regionkind create <regionKind>
Set a region to belong to a certain RegionKind
Command: /arm setregionkind <regionId> <regionKind>
List regionkinds:
Command: /arm regionkind list
Deleting a Regionkind:
Command: /arm regionkind delete <regionKind>
Showing information about a Regionkind:
Command: /arm regionkind info <regionKind>
Output:
Changing the display name of a Regionkind:
Command: /arm regionkind setdisplayname <RegionKind> <DisplayName>
Changes the displayname of a Regionkind that is shown to the players. This name can also include colors. Commands and configurations will still use the name that the regionkind was created with.
Set if the RegionKind should be shown in /arm limit:
Command: /arm regionkind setdisplayinlimits <regionKind> (true/false)
Set if the RegionKind should be shown in /arm regionfinder:
Command: /arm regionkind setdisplayinregionfinder <regionKind> (true/false)
Set the item for the RegionKind to be shown in the GUI:
Command: /arm regionkind setitem <regionKind> <item>
The <item>-parameter should autocomplete when typing in the command:
Add a new lore line to the RegionKind
When opening the regionfinder a small text is being shown when hovering over the item of the RegionKind. To add a new line to that text, use the following command:
Command: /arm regionkind addloreline <regionKind> <NewLoreLine>
Remove a lore line from the RegionKind
When opening the regionfinder a small text is being shown when hovering over the item of the RegionKind. To remove a line from that text, use the following command:
Command: /arm regionkind removeloreline <regionKind> <lineNumber>
Creating a RegionkindGroup:
Command: /arm regionkindgroup create <regionkindGroup>
Deleting a RegionkindGroup:
Command: /arm regionkindgroup delete <regionkindGroup>
Showing information about a RegionkindGroup:
Command: /arm regionkindgroup info <regionkindGroup>
List RegionkindGroups:
Command: /arm regionkindgroup list
Add a Regionkind to a RegionkindGroup:
Command: /arm regionkindgroup addregionkind <regionkindGroup> <regionKind>
Remove a Regionkind from a RegionkindGroup:
Command: /arm regionkindgroup removeregionkind <regionkindGroup> <regionKind>
Set if the RegionKindGroup should be shown in /arm limit:
Command: /arm regionkindgroup setdisplayinlimits <regionkindGroup> (true/false)
Changing the display name of a RegionkindGroup:
Command: /arm regionkindgroup setdisplayname <regionkindGroup> <DisplayName>
Changes the displayname of a Regionkind that is shown to the players. This name can also include colors. Commands and configurations will still use the name that the regionkind was created with.