ProtectionStones

https://jdps.espi.dev/
Admin
ProtectionStones is an API providing functionalities for managing and interacting with protection...
Tokens:106,446
Snippets:842
Trust Score:7.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Setup ProtectionStones Recipes

Source: https://jdps.espi.dev/index-all

A static method to set up all necessary ProtectionStones recipes.

```Java
setupPSRecipes() - Static method in class dev.espi.protectionstones.utils.RecipeUtil
```

--------------------------------

### Instance and Logger Retrieval

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

Methods to get the plugin instance and the plugin's logger.

```APIDOC
## GET /instance

### Description
Retrieves the current instance of the ProtectionStones plugin.

### Method
GET

### Endpoint
/instance

### Response
#### Success Response (200)
- **instance** (ProtectionStones) - The plugin instance.

## GET /logger

### Description
Retrieves the plugin's logger.

### Method
GET

### Endpoint
/logger

### Response
#### Success Response (200)
- **logger** (Logger) - The plugin's logger instance.
```

--------------------------------

### Setup Protection Stones Recipes

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/RecipeUtil

Sets up the Protection Stones (PS) recipes. This static method is responsible for adding all predefined recipes to the game.

```java
public static void setupPSRecipes()
```

--------------------------------

### Get Rent Help Command

Source: https://jdps.espi.dev/index-all

Provides help information for the rent command. This static method is in ArgRent.

```java
getRentHelp() - Static method in class dev.espi.protectionstones.commands.ArgRent
     
```

--------------------------------

### Get GUI (ArgMerge)

Source: https://jdps.espi.dev/index-all

Static method in dev.espi.protectionstones.commands.ArgMerge to generate a GUI for merging regions. It requires a Player and a PSRegion.

```java
public static void getGUI(Player player, PSRegion region) {
    // Implementation details...
}
```

--------------------------------

### Get Stop Renting Help Command

Source: https://jdps.espi.dev/index-all

Provides help information for stopping the renting of a region. This static method is in ArgRent.

```java
getStopRentingHelp() - Static method in class dev.espi.protectionstones.commands.ArgRent
     
```

--------------------------------

### Get Plugin Instance (ProtectionStones)

Source: https://jdps.espi.dev/index-all

Static method in dev.espi.protectionstones.ProtectionStones to retrieve the singleton instance of the ProtectionStones plugin.

```java
public static ProtectionStones getInstance() {
    // Implementation details...
}
```

--------------------------------

### Get Amount (TaxPayment)

Source: https://jdps.espi.dev/index-all

Method in dev.espi.protectionstones.PSRegion.TaxPayment to get the amount of a tax payment.

```java
public double getAmount() {
    // Implementation details...
}
```

--------------------------------

### Get Author (PSPlaceholderExpansion)

Source: https://jdps.espi.dev/index-all

Method in dev.espi.protectionstones.placeholders.PSPlaceholderExpansion to get the author of the placeholder expansion.

```java
public String getAuthor() {
    // Implementation details...
}
```

--------------------------------

### Initialize Help Menu (dev.espi.protectionstones.commands.ArgHelp)

Source: https://jdps.espi.dev/index-all

This static method is responsible for initializing the help menu within the ArgHelp class. It is used to set up the command-line interface's help functionalities, likely displaying available commands and their descriptions.

```java
initHelpMenu()
```

--------------------------------

### Get Stop Lease Help Command

Source: https://jdps.espi.dev/index-all

Provides help information for stopping the lease of a region. This static method is in ArgRent.

```java
getStopLeaseHelp() - Static method in class dev.espi.protectionstones.commands.ArgRent
     
```

--------------------------------

### Get Placeholder Identifier (PSPlaceholderExpansion)

Source: https://jdps.espi.dev/index-all

Method in dev.espi.protectionstones.placeholders.PSPlaceholderExpansion to get the unique identifier for this placeholder expansion.

```java
public String getIdentifier() {
    // Implementation details...
}
```

--------------------------------

### Block Information Retrieval

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

Methods to get configuration options for protection blocks based on various identifiers.

```APIDOC
## GET /blocks/options/block

### Description
Gets the protection block configuration options for a given Bukkit Block.

### Method
GET

### Endpoint
/blocks/options/block

### Parameters
#### Query Parameters
- **block** (org.bukkit.block.Block) - Required - The block to get the options for.

### Response
#### Success Response (200)
- **blockOptions** (PSProtectBlock) - The configuration options for the specified block (null if not found).

## GET /blocks/options/item

### Description
Gets the protection block configuration options for a given ItemStack.

### Method
GET

### Endpoint
/blocks/options/item

### Parameters
#### Query Parameters
- **item** (org.bukkit.inventory.ItemStack) - Required - The item to get the options for.

### Response
#### Success Response (200)
- **blockOptions** (PSProtectBlock) - The configuration options for the specified item (null if not found).

## GET /blocks/options/type

### Description
Gets the configuration options for a protection block type specified by its material name.

### Method
GET

### Endpoint
/blocks/options/type

### Parameters
#### Query Parameters
- **blockType** (String) - Required - The material type name (Bukkit) or 'PLAYER_HEAD name'.

### Response
#### Success Response (200)
- **blockOptions** (PSProtectBlock) - The configuration options for the specified block type (null if not found).
```

--------------------------------

### Get Region Home Location

Source: https://jdps.espi.dev/index-all

Methods to get the home location of a region. Overloaded for PSMergedRegion, PSRegion, and PSStandardRegion.

```java
public Location getHome() // PSMergedRegion
public Location getHome() // PSRegion
public Location getHome() // PSStandardRegion
```

--------------------------------

### PSPlaceholderExpansion Constructor and Methods - Java

Source: https://jdps.espi.dev/dev/espi/protectionstones/placeholders/PSPlaceholderExpansion

This snippet shows the constructor and key methods of the PSPlaceholderExpansion class. It includes methods for registering the expansion, retrieving author and version information, and handling placeholder requests from players. These methods are essential for integrating custom placeholders with the PlaceholderAPI plugin.

```java
public class PSPlaceholderExpansion extends me.clip.placeholderapi.expansion.PlaceholderExpansion {

  public PSPlaceholderExpansion() {
  }

  public boolean persist() {
    return true;
  }

  public boolean canRegister() {
    return true;
  }

  public String getIdentifier() {
    return "ps";
  }

  public String getAuthor() {
    return "YourName";
  }

  public String getVersion() {
    return "1.0";
  }

  public String onPlaceholderRequest(org.bukkit.entity.Player p, String identifier) {
    if (p == null) {
      return "";
    }
    
    // Logic to handle placeholders based on identifier
    if (identifier.equals("stones_count")) {
      return String.valueOf(getStoneCount(p)); // Example placeholder
    }
    
    return null;
  }
  
  private int getStoneCount(org.bukkit.entity.Player player) {
    // Replace with actual logic to get stone count
    return 0;
  }
}
```

--------------------------------

### Get Last Payment Added (LastRegionTaxPaymentEntry)

Source: https://jdps.espi.dev/index-all

Method in dev.espi.protectionstones.PSRegion.LastRegionTaxPaymentEntry to get the timestamp of the last tax payment added for a region.

```java
public long getLastPaymentAdded() {
    // Implementation details...
}
```

--------------------------------

### ArgRent Lease and Rent Help Methods

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgRent

Static methods to retrieve help text related to leasing and renting functionality within the Protection Stones plugin.

```java
public static String getLeaseHelp()

```

```java
public static String getStopLeaseHelp()

```

```java
public static String getRentHelp()

```

```java
public static String getStopRentingHelp()

```

--------------------------------

### RecipeUtil Constructor

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/RecipeUtil

Initializes a new instance of the RecipeUtil class. This is the default constructor and does not require any parameters.

```java
public RecipeUtil()
```

--------------------------------

### Get Economy Instance (ProtectionStones)

Source: https://jdps.espi.dev/index-all

Static method in dev.espi.protectionstones.ProtectionStones to get the current economy instance managed by the plugin. This is essential for economy-related operations.

```java
public static Economy getEconomy() {
    // Implementation details...
}
```

--------------------------------

### JDPS ESPi Dev API Search Examples

Source: https://jdps.espi.dev/help-doc

Demonstrates how to use the API search functionality with camel-case abbreviations for efficient lookup of definitions.

```text
j.l.obj
InpStr
HM.cK
```

--------------------------------

### Protection Block Start with Tax Autopay

Source: https://jdps.espi.dev/index-all

A variable within PSProtectBlock that indicates whether the protection block starts with tax autopay enabled.

```Java
startWithTaxAutopay - Variable in class dev.espi.protectionstones.PSProtectBlock
```

--------------------------------

### TextGUI Constructor

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/TextGUI

Initializes a new instance of the TextGUI class. This constructor does not take any arguments.

```java
public TextGUI()
```

--------------------------------

### Get and Set Region Name (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSMergedRegion

Provides methods to get the nickname of the region (set via /ps name) and to set or remove this nickname.

```Java
public String getName()
public void setName(String name)
```

--------------------------------

### Get Configured Blocks (ProtectionStones)

Source: https://jdps.espi.dev/index-all

Method in dev.espi.protectionstones.ProtectionStones that returns a list of all protection blocks configured via the plugin's configuration files.

```java
public List<PSProtectBlock> getConfiguredBlocks() {
    // Implementation details...
}
```

--------------------------------

### Get Config Options (ProtectionStones)

Source: https://jdps.espi.dev/index-all

Method in dev.espi.protectionstones.ProtectionStones to retrieve the plugin's general configuration options. This provides access to various plugin settings.

```java
public PluginConfig getConfigOptions() {
    // Implementation details...
}
```

--------------------------------

### Get PSProtectBlock Options

Source: https://jdps.espi.dev/dev/espi/protectionstones/class-use/PSProtectBlock

Retrieves configuration options for protection blocks based on type, a specific Bukkit block, or an ItemStack. It also includes a method to get options by alias.

```Java
static PSProtectBlock
ProtectionStones.getBlockOptions(String blockType)

static PSProtectBlock
ProtectionStones.getBlockOptions(org.bukkit.block.Block block)

static PSProtectBlock
ProtectionStones.getBlockOptions(org.bukkit.inventory.ItemStack item)

static PSProtectBlock
ProtectionStones.getProtectBlockFromAlias(String name)
```

--------------------------------

### Configuration and Debugging - Java

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

Methods for managing plugin configuration and debugging output. This includes loading configuration files, setting debug mode, and printing debug messages.

```Java
public static void loadConfig(boolean isReload) {
  // Loads or reloads the plugin's configuration.
}
public void setDebug(boolean debug) {
  // Enables or disables debug mode for the plugin.
}
public void debug(String msg) {
  // Prints a debug message if debug mode is enabled.
}
public PSConfig getConfigOptions() {
  // Retrieves the current plugin configuration options.
}
public void setConfigOptions(PSConfig conf) {
  // Sets the plugin's configuration options.
}
```

--------------------------------

### Get Block Options (ProtectionStones)

Source: https://jdps.espi.dev/index-all

Overloaded static methods in dev.espi.protectionstones.ProtectionStones to get configuration options for different types of protection blocks based on String identifier, Block object, or ItemStack.

```java
public static ProtectionBlockOptions getBlockOptions(String blockType) {
    // Implementation details...
}

public static ProtectionBlockOptions getBlockOptions(Block block) {
    // Implementation details...
}

public static ProtectionBlockOptions getBlockOptions(ItemStack item) {
    // Implementation details...
}
```

--------------------------------

### ArgHelp Method Details (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgHelp

Provides details for various methods within the ArgHelp class, including initialization, name retrieval, execution logic, and tab completion.

```java
public static void initHelpMenu()
    * ### getNames
public List<String> getNames()

Specified by:
    getNames in interface PSCommandArg
    * ### allowNonPlayersToExecute
public boolean allowNonPlayersToExecute()

Specified by:
    allowNonPlayersToExecute in interface PSCommandArg
    * ### getPermissionsToExecute
public List<String> getPermissionsToExecute()

Specified by:
    getPermissionsToExecute in interface PSCommandArg
    * ### getRegisteredFlags
public HashMap<String, Boolean> getRegisteredFlags()

Specified by:
    getRegisteredFlags in interface PSCommandArg
    * ### executeArgument
public boolean executeArgument(org.bukkit.command.CommandSender p, String[] args, HashMap<String, String> flags)

Specified by:
    executeArgument in interface PSCommandArg
    * ### tabComplete
public List<String> tabComplete(org.bukkit.command.CommandSender sender, String alias, String[] args)

Specified by:
    tabComplete in interface PSCommandArg
```

--------------------------------

### Get Mergeable PSRegions

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSMergedRegion

Gets a list of regions that the current region can merge with, considering a player's permissions. This method is specified in the PSRegion class and takes a Player object as input.

```java
public List<PSRegion> getMergeableRegions(org.bukkit.entity.Player p)
```

--------------------------------

### LimitUtil Constructor - Java

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/LimitUtil

Initializes a new instance of the LimitUtil class. This constructor has no parameters.

```java
public LimitUtil()
```

--------------------------------

### Plugin Integration (Economy & Permissions) - Java

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

Methods for integrating with external plugins like Vault for economy and LuckPerms for permissions. This includes checking if support is enabled and retrieving API instances.

```Java
public static PSEconomy getEconomy() {
  // Gets the PSEconomy instance, likely for Vault integration.
}
public net.milkbowl.vault.economy.Economy getVaultEconomy() {
  // Gets the Vault Economy API if support is enabled.
}
public net.luckperms.api.LuckPerms getLuckPerms() {
  // Gets the LuckPerms API if support is enabled.
}
public boolean isVaultSupportEnabled() {
  // Checks if Vault economy support is enabled.
}
public boolean isLuckPermsSupportEnabled() {
  // Checks if LuckPerms support is enabled.
}
```

--------------------------------

### Get and Set Region Name

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSStandardRegion

Manages the nickname of a region, typically set via the '/ps name' command. It allows getting the current name or setting a new one, including removing the name.

```java
public String getName()
Description copied from class: PSRegion
Get the name (nickname) of the region from /ps name. 
Specified by:
getName in class PSRegion 
Returns:
the name of the region, or null if the region does not have a name
```

```java
public void setName(String name)
Description copied from class: PSRegion
Set the name of the region (from /ps name). 
Specified by:
setName in class PSRegion 
Parameters:
name - new name, or null to remove the name
```

--------------------------------

### Get and Set Region Home Location

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSStandardRegion

Manages the home location for a region, used for teleportation commands like '/ps tp'. It allows getting the current home location or setting a new one using block coordinates, optionally with yaw and pitch.

```java
public org.bukkit.Location getHome()
Description copied from class: PSRegion
Get the location of the set home the region has (for /ps tp). 
Specified by:
getHome in class PSRegion 
Returns:
the location of the home, or null if the ps_home flag is not set.
```

```java
public void setHome(double blockX, double blockY, double blockZ)
Description copied from class: PSRegion
Set the home of the region (internally changes the flag). 
Specified by:
setHome in class PSRegion 
Parameters:
blockX - block x location     blockY - block y location     blockZ - block z location
```

```java
public void setHome(double blockX, double blockY, double blockZ, float yaw, float pitch)
Description copied from class: PSRegion
Set the home of the region (internally changes the flag). 
Specified by:
setHome in class PSRegion 
Parameters:
blockX - block x location     blockY - block y location     blockZ - block z location     yaw - location yaw     pitch - location pitch
```

--------------------------------

### ArgTax: Command Argument Handling Methods (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgTax

Details methods for handling command arguments and completions. Includes getting command names, permissions, registered flags, and tab completion logic.

```java
public List<String> getNames()
public List<String> getPermissionsToExecute()
public HashMap<String,Boolean> getRegisteredFlags()
public List<String> tabComplete(org.bukkit.command.CommandSender sender, String alias, String[] args)
```

--------------------------------

### Get Tax Rate

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSGroupRegion

Retrieves the tax rate associated with the region.

```APIDOC
## GET /region/taxRate

### Description
Gets the tax rate for this region type.

### Method
GET

### Endpoint
/region/taxRate

### Parameters
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **taxRate** (double) - the tax rate

#### Response Example
```json
{
  "taxRate": 0.15
}
```
```

--------------------------------

### ArgToggleOn Class

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgToggle

Details about the ArgToggleOn class, its constructors, and methods.

```APIDOC
## Class ArgToggle.ArgToggleOn

### Description
Represents the 'on' argument for the ArgToggle command.

### Methods

**getNames**
* **Description**: Gets the names associated with this command argument.
* **Returns**: A list of strings representing the names.
* **Implemented in**: `PSCommandArg`

**allowNonPlayersToExecute**
* **Description**: Checks if non-players are allowed to execute this command argument.
* **Returns**: `true` if non-players can execute, `false` otherwise.

**getPermissionsToExecute**
* **Description**: Gets the list of permissions required to execute this command argument.
* **Returns**: A list of strings representing the required permissions.
* **Implemented in**: `PSCommandArg`

**getRegisteredFlags**
* **Description**: Gets a map of registered flags for this command argument.
* **Returns**: A HashMap where keys are flag names and values are booleans indicating their status.
* **Implemented in**: `PSCommandArg`

**executeArgument**
* **Description**: Executes the command logic for this argument.
* **Parameters**:
    * `s` (CommandSender) - The sender of the command.
    * `args` (String[]) - The arguments passed to the command.
    * `flags` (HashMap<String, String>) - A map of flags passed to the command.
* **Returns**: `true` if the argument was executed successfully, `false` otherwise.
* **Implemented in**: `PSCommandArg`

**tabComplete**
* **Description**: Provides tab completion suggestions for the command argument.
* **Parameters**:
    * `sender` (CommandSender) - The sender of the command.
    * `alias` (String) - The alias used to execute the command.
    * `args` (String[]) - The arguments entered so far.
* **Returns**: A list of strings for tab completion suggestions.
* **Implemented in**: `PSCommandArg`
```

--------------------------------

### Java: MiscUtil Class Documentation

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/MiscUtil

This snippet details the public constructor and static methods of the MiscUtil Java class. It includes methods for concatenating strings, describing durations, retrieving LuckPerms permissions, getting permission numbers, encoding UUIDs, and getting version strings. Some methods handle potential exceptions like NumberFormatException, ExecutionException, and InterruptedException.

```java
public class MiscUtil extends Object
  * ## Constructor Summary
Constructors
Constructor
Description
`MiscUtil()`
  * ## Method Summary
All MethodsStatic MethodsConcrete Methods
Modifier and Type
Method
Description
`static String`
`concatWithoutLast(List<String> l,  String separator)`
`static String`
`describeDuration(Duration duration)`
`static List<String>`
`getLuckPermsUserPermissions(UUID uniqueId)`
`static int`
`getPermissionNumber(List<String> permissions,  String perm,  int def)`
`static int`
`getPermissionNumber(org.bukkit.entity.Player p,  String perm,  int def)`
`static String`
`getUniqueIdIntArray(UUID uuid)`
`static String`
`getVersionString()`
`static Duration`
`parseRentPeriod(String period)`
### Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`


  * ## Constructor Details
    * ### MiscUtil
public MiscUtil()
  * ## Method Details
    * ### getUniqueIdIntArray
public static String getUniqueIdIntArray(UUID uuid)
    * ### getVersionString
public static String getVersionString()
    * ### parseRentPeriod
public static Duration parseRentPeriod(String period) throws NumberFormatException 

Throws:
    `NumberFormatException`
    * ### getPermissionNumber
public static int getPermissionNumber(org.bukkit.entity.Player p, String perm, int def)
    * ### getPermissionNumber
public static int getPermissionNumber(List<String> permissions, String perm, int def)
    * ### concatWithoutLast
public static String concatWithoutLast(List<String> l, String separator)
    * ### describeDuration
public static String describeDuration(Duration duration)
    * ### getLuckPermsUserPermissions
public static List<String> getLuckPermsUserPermissions(UUID uniqueId) throws ExecutionException, InterruptedException 

Throws:
    `ExecutionException`     `InterruptedException`
```

--------------------------------

### ArgHideUnhide Constructor

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgHideUnhide

Initializes a new instance of the ArgHideUnhide class. This is the default constructor.

```java
public ArgHideUnhide()

```

--------------------------------

### ArgFlag Constructor

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgFlag

Initializes a new instance of the ArgFlag class.

```APIDOC
## POST /api/argflag/constructor

### Description
Creates a new ArgFlag object.

### Method
POST

### Endpoint
/api/argflag/constructor

### Parameters
#### Request Body
(No specific request body parameters for the default constructor)

### Request Example
```json
{} 
```

### Response
#### Success Response (201)
- **message** (string) - Confirmation that the ArgFlag object was created.

#### Response Example
```json
{
  "message": "ArgFlag object created successfully."
}
```
```

--------------------------------

### Get Merged Regions

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSGroupRegion

Retrieves a list of PSMergedRegion objects that were merged into this region.

```APIDOC
## GET /region/mergedRegions

### Description
Get the list of `PSMergedRegion` objects of the regions that were merged into this region.

### Method
GET

### Endpoint
/region/mergedRegions

### Parameters
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **mergedRegions** (List<PSMergedRegion>) - the list of regions merged into this region

#### Response Example
```json
{
  "mergedRegions": [
    { "id": "merged-region-a" },
    { "id": "merged-region-b" }
  ]
}
```
```

--------------------------------

### Get Tax Period

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSGroupRegion

Retrieves the formatted period(s) between tax payments for the region.

```APIDOC
## GET /region/taxPeriod

### Description
Gets the formatted period(s) between tax payments for this region type.

### Method
GET

### Endpoint
/region/taxPeriod

### Parameters
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **taxPeriod** (String) - the duration between tax payments, or multiple if there are several different ones

#### Response Example
```json
{
  "taxPeriod": "Monthly"
}
```
```

--------------------------------

### PSEconomy Constructor and Core Methods (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSEconomy

Initializes the PSEconomy handler and provides core functionalities for managing rented regions and processing economy-related events like rent payments and taxes.

```java
public class PSEconomy extends Object {
    public PSEconomy() {
    }

    public void stop() {
        // Stops the economy cycle.
    }

    public void loadRentList() {
        // Load list of regions that are rented into memory.
    }

    public static void processTaxes(PSRegion r) {
        // Process taxes for a region.
    }

    public static void doRentPayment(PSRegion r) {
        // Process a rent payment for a region.
    }

    public List<PSRegion> getRentedList() {
        // Get list of rented regions.
        return null;
    }
}
```

--------------------------------

### Get Tax Payment Period

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSGroupRegion

Retrieves the formatted period(s) allowed for the payment of tax.

```APIDOC
## GET /region/taxPaymentPeriod

### Description
Gets the formatted period(s) allowed for the payment of tax.

### Method
GET

### Endpoint
/region/taxPaymentPeriod

### Parameters
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **taxPaymentPeriod** (String) - the duration of time allowed to pay a tax, or multiple if there are several different ones

#### Response Example
```json
{
  "taxPaymentPeriod": "30 days"
}
```
```

--------------------------------

### Configuration Management

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

Methods for managing plugin configuration options and block configurations.

```APIDOC
## GET /config/options

### Description
Retrieves the current configuration options for ProtectionStones.

### Method
GET

### Endpoint
/config/options

### Response
#### Success Response (200)
- **configOptions** (PSConfig) - The current configuration options.

## PUT /config/options

### Description
Replaces the current configuration options with a new configuration object.

### Method
PUT

### Endpoint
/config/options

### Parameters
#### Request Body
- **conf** (PSConfig) - Required - The new configuration object.

### Response
#### Success Response (200)
Indicates that the configuration options were updated successfully.

## GET /config/blocks

### Description
Retrieves the list of PSProtectBlocks configured through the config file.

### Method
GET

### Endpoint
/config/blocks

### Response
#### Success Response (200)
- **configuredBlocks** (List<PSProtectBlock>) - A list of configured protection blocks.
```

--------------------------------

### ArgInfo Class Definition and Constructor

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgInfo

Defines the ArgInfo class, which extends Object and implements the PSCommandArg interface. Includes the default constructor for ArgInfo.

```java
public class ArgInfo extends Object implements PSCommandArg

public ArgInfo()
```

--------------------------------

### Get Merged Regions - PSRegion

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSGroupRegion

Retrieves a list of PSMergedRegion objects that were merged into this region.

```java
public List<PSMergedRegion> getMergedRegions()
Get the list of PSMergedRegion objects of the regions that were merged into this region. 

Returns:
    the list of regions merged into this region
```

--------------------------------

### Get Region Type

Source: https://jdps.espi.dev/index-all

Retrieves the type of a region. Available for PSMergedRegion, PSRegion, and PSStandardRegion.

```java
getType() - Method in class dev.espi.protectionstones.PSMergedRegion
     
```

```java
getType() - Method in class dev.espi.protectionstones.PSRegion
     
```

```java
getType() - Method in class dev.espi.protectionstones.PSStandardRegion
     
```

--------------------------------

### Get Tenant

Source: https://jdps.espi.dev/index-all

Retrieves the tenant of a region. This method is implemented in PSMergedRegion, PSRegion, and PSStandardRegion.

```java
getTenant() - Method in class dev.espi.protectionstones.PSMergedRegion
     
```

```java
getTenant() - Method in class dev.espi.protectionstones.PSRegion
    
Get the tenant of the region. 
```

```java
getTenant() - Method in class dev.espi.protectionstones.PSStandardRegion
     
```

--------------------------------

### Display GUI Method

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/TextGUI

Displays a graphical user interface to a command sender. It takes parameters for the sender, header, pagination details, lines of text, and whether to send blank lines. Dependencies include Bukkit API for CommandSender and Bungee API for TextComponent.

```java
public static void displayGUI(org.bukkit.command.CommandSender s, String header, String pageCommand, int currentPage, int guiSize, List<net.md_5.bungee.api.chat.TextComponent> lines, boolean sendBlankLines)
```

--------------------------------

### BlockUtil Class Overview

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/BlockUtil

Provides a summary of the BlockUtil class, including its fields, constructors, and methods. It details functionalities for interacting with protection blocks and their properties.

```java
public class BlockUtil extends Object
  * ## Field Summary
Fields
Modifier and Type
Field
Description
`static HashMap<String,String>`
`uuidToBase64Head`
  * ## Constructor Summary
Constructors
Constructor
Description
`BlockUtil()`
  * ## Method Summary
All MethodsStatic MethodsConcrete Methods
Modifier and Type
Method
Description
`static org.bukkit.inventory.ItemStack`
`getProtectBlockItemFromType(String type)`
`static String`
`getProtectBlockType(org.bukkit.block.Block block)`
`static String`
`getProtectBlockType(org.bukkit.inventory.ItemStack i)`
`static String`
`getUUIDFromBase64PS(PSProtectBlock b)`
`static boolean`
`isBase64PSHead(String type)`
`static void`
`setHeadType(String psType,  org.bukkit.block.Block b)`
`static org.bukkit.inventory.ItemStack`
`setHeadType(String psType,  org.bukkit.inventory.ItemStack item)`
### Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
```

--------------------------------

### ArgHome Methods Implementation (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgHome

Provides implementations for methods required by the PSCommandArg interface, including command names, execution permissions, registered flags, and tab completion logic.

```Java
public List<String> getNames()

Specified by:
    getNames in interface PSCommandArg
```

```Java
public boolean allowNonPlayersToExecute()

Specified by:
    allowNonPlayersToExecute in interface PSCommandArg
```

```Java
public List<String> getPermissionsToExecute()

Specified by:
    getPermissionsToExecute in interface PSCommandArg
```

```Java
public HashMap<String, Boolean> getRegisteredFlags()

Specified by:
    getRegisteredFlags in interface PSCommandArg
```

```Java
public List<String> tabComplete(org.bukkit.command.CommandSender sender, String alias, String[] args)

Specified by:
    tabComplete in interface PSCommandArg
```

```Java
public boolean executeArgument(org.bukkit.command.CommandSender s, String[] args, HashMap<String, String> flags)

Specified by:
    executeArgument in interface PSCommandArg
```

--------------------------------

### Get Root Region

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSGroupRegion

Retrieves the merged region that shares the same ID as the group region ID.

```APIDOC
## GET /region/rootRegion

### Description
Get the merged region whose ID is the same as the group region ID.

### Method
GET

### Endpoint
/region/rootRegion

### Parameters
(None)

### Request Example
(None)

### Response
#### Success Response (200)
- **rootRegion** (PSMergedRegion) - the root region

#### Response Example
```json
{
  "rootRegion": {
    "id": "root-region-123"
  }
}
```
```

--------------------------------

### FlagHandler Method Summary (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/FlagHandler

Summarizes the methods available in the FlagHandler class. Includes static methods getPlayerPlaceholderFlags and initDefaultFlagPlaceholders, along with inherited methods from java.lang.Object.

```java
static List<String> getPlayerPlaceholderFlags()
static void initDefaultFlagPlaceholders(HashMap<com.sk89q.worldguard.protection.flags.Flag<?>,Object> flags,  org.bukkit.entity.Player p)
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
```

--------------------------------

### Get Registered Flags

Source: https://jdps.espi.dev/index-all

Retrieves a list of registered flags. This method is defined in the PSCommandArg interface.

```java
getRegisteredFlags() - Method in interface dev.espi.protectionstones.commands.PSCommandArg
     
```

--------------------------------

### Create ParticlesUtil Instance

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/ParticlesUtil

This constructor initializes a new instance of the ParticlesUtil class. It does not take any arguments.

```java
public ParticlesUtil()
```

--------------------------------

### Get Placeholder Expansion Version

Source: https://jdps.espi.dev/index-all

Retrieves the version of the PSPlaceholderExpansion. This method is part of the PSPlaceholderExpansion class.

```java
getVersion() - Method in class dev.espi.protectionstones.placeholders.PSPlaceholderExpansion
     
```

--------------------------------

### ArgList Method Details

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgList

Detailed explanations for each method within the ArgList class, including their purpose, return types, and parameters.

```APIDOC
## Method: getNames()

### Description
Retrieves the names of the arguments.

### Method
`public List<String> getNames()`

### Returns
`List<String>` - A list containing the names of the arguments.

### Implemented In
`PSCommandArg`
```

```APIDOC
## Method: allowNonPlayersToExecute()

### Description
Checks if non-player entities are allowed to execute the command.

### Method
`public boolean allowNonPlayersToExecute()`

### Returns
`boolean` - `true` if non-players can execute, `false` otherwise.

### Implemented In
`PSCommandArg`
```

```APIDOC
## Method: getPermissionsToExecute()

### Description
Retrieves the permissions required to execute the command.

### Method
`public List<String> getPermissionsToExecute()`

### Returns
`List<String>` - A list of permission strings required for execution.

### Implemented In
`PSCommandArg`
```

```APIDOC
## Method: getRegisteredFlags()

### Description
Retrieves a map of registered flags for the command.

### Method
`public HashMap<String, Boolean> getRegisteredFlags()`

### Returns
`HashMap<String, Boolean>` - A map where keys are flag names and values indicate their type (e.g., boolean).

### Implemented In
`PSCommandArg`
```

```APIDOC
## Method: executeArgument(CommandSender s, String[] args, HashMap<String, String> flags)

### Description
Executes the command argument with the given sender, arguments, and flags.

### Method
`public boolean executeArgument(org.bukkit.command.CommandSender s, String[] args, HashMap<String, String> flags)`

### Parameters
- **s** (`org.bukkit.command.CommandSender`) - The sender of the command.
- **args** (`String[]`) - An array of strings representing the command arguments.
- **flags** (`HashMap<String, String>`) - A map of flags associated with the command.

### Returns
`boolean` - `true` if the argument was executed successfully, `false` otherwise.

### Implemented In
`PSCommandArg`
```

```APIDOC
## Method: tabComplete(CommandSender sender, String alias, String[] args)

### Description
Provides tab completion suggestions for the command arguments.

### Method
`public List<String> tabComplete(org.bukkit.command.CommandSender sender, String alias, String[] args)`

### Parameters
- **sender** (`org.bukkit.command.CommandSender`) - The sender requesting tab completion.
- **alias** (`String`) - The alias of the command being used.
- **args** (`String[]`) - An array of strings representing the current arguments entered.

### Returns
`List<String>` - A list of possible tab completion strings.

### Implemented In
`PSCommandArg`
```

--------------------------------

### Get UUID from Base64 PS

Source: https://jdps.espi.dev/index-all

Retrieves a UUID from a PSProtectBlock. This is a static utility method in BlockUtil.

```java
getUUIDFromBase64PS(PSProtectBlock) - Static method in class dev.espi.protectionstones.utils.BlockUtil
     
```

--------------------------------

### Get Player UUID

Source: https://jdps.espi.dev/index-all

Retrieves the UUID of the wrapped player. This method belongs to the PSPlayer class.

```java
getUuid() - Method in class dev.espi.protectionstones.PSPlayer
    
Get the wrapped player's uuid. 
```

--------------------------------

### Handle ProtectionStones plugin initialization

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

The primary initialization method for the ProtectionStones plugin. This method is called when the plugin is loaded by the server, performing essential setup tasks.

```java
public void onLoad()
```

--------------------------------

### LegacyUpgrade Constructor (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/upgrade/LegacyUpgrade

Provides the default constructor for the LegacyUpgrade class. No specific initialization logic is detailed.

```Java
public LegacyUpgrade()
```

--------------------------------

### Get Landlord Information

Source: https://jdps.espi.dev/index-all

Methods to retrieve the landlord of a region. Available for PSMergedRegion, PSRegion, and PSStandardRegion.

```java
public OfflinePlayer getLandlord() // PSMergedRegion
public OfflinePlayer getLandlord() // PSRegion
public OfflinePlayer getLandlord() // PSStandardRegion
```

--------------------------------

### Get Player Homes (PSPlayer)

Source: https://jdps.espi.dev/index-all

Method in dev.espi.protectionstones.PSPlayer to retrieve a list of all homes that a player has set.

```java
public List<Location> getHomes(World world) {
    // Implementation details...
}
```

--------------------------------

### Utility Methods for Region Data and Checks

Source: https://jdps.espi.dev/dev/espi/protectionstones/utils/WGUtils

Encompasses various utility methods such as getting the default protected region, retrieving the flag registry, calculating vector points, checking for access, and matching locations to PSIDs.

```java
public static com.sk89q.worldguard.protection.regions.ProtectedCuboidRegion
 getDefaultProtectedRegion(PSProtectBlock b,  PSLocation v) {
  // Implementation details omitted for brevity
}

public static com.sk89q.worldguard.protection.flags.registry.FlagRegistry
 getFlagRegistry() {
  // Implementation details omitted for brevity
}

public static com.sk89q.worldedit.math.BlockVector3
 getMaxChunkVector(double bx,  double by,  double bz,  long chunkRadius,  long yRadius) {
  // Implementation details omitted for brevity
}

public static com.sk89q.worldedit.math.BlockVector3
 getMaxVector(double bx,  double by,  double bz,  long xRadius,  long yRadius,  long zRadius) {
  // Implementation details omitted for brevity
}

public static com.sk89q.worldedit.math.BlockVector3
 getMinChunkVector(double bx,  double by,  double bz,  long chunkRadius,  long yRadius) {
  // Implementation details omitted for brevity
}

public static com.sk89q.worldedit.math.BlockVector3
 getMinVector(double bx,  double by,  double bz,  long xRadius,  long yRadius,  long zRadius) {
  // Implementation details omitted for brevity
}

public static HashMap<String,
 ArrayList<String>>
 getPlayerAdjacentRegionGroups(org.bukkit.entity.Player p,  com.sk89q.worldguard.protection.managers.RegionManager rm) {
  // Implementation details omitted for brevity
}

public static List<com.sk89q.worldedit.math.BlockVector2>
 getPointsFromDecomposedRegion(PSRegion r) {
  // Implementation details omitted for brevity
}

public static List<com.sk89q.worldguard.protection.regions.ProtectedRegion>
 getTransientEdgeRegions(org.bukkit.World w,  com.sk89q.worldguard.protection.regions.ProtectedRegion r) {
  // Find the list of regions that border `r` (adjacent to the edge), but do not include the corners.
  // Implementation details omitted for brevity
}

public static boolean
 hasNoAccess(com.sk89q.worldguard.protection.regions.ProtectedRegion region,  org.bukkit.entity.Player p,  com.sk89q.worldguard.LocalPlayer lp,  boolean canBeMember) {
  // Implementation details omitted for brevity
}

public static String
 matchLocationToPSID(org.bukkit.Location l) {
  // Implementation details omitted for brevity
}

public static boolean
 overlapsStrongerRegion(org.bukkit.World w,  com.sk89q.worldguard.protection.regions.ProtectedRegion r,  com.sk89q.worldguard.LocalPlayer lp) {
  // Implementation details omitted for brevity
}

public static PSLocation
 parsePSRegionToLocation(String regionId) {
  // Implementation details omitted for brevity
}

```

--------------------------------

### Autopayer Management

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSMergedRegion

Methods for getting and setting the player responsible for autopaying taxes for a region.

```APIDOC
## GET /getTaxAutopayer

### Description
Gets the player who is set to autopay the tax amount for the region.

### Method
GET

### Endpoint
/getTaxAutopayer

### Response
#### Success Response (200)
- **autopayerUuid** (UUID) - The UUID of the player set as the autopayer, or null if no player is set.

### Response Example
{
  "autopayerUuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

```APIDOC
## POST /setTaxAutopayer

### Description
Sets a player to auto-pay taxes for this region.

### Method
POST

### Endpoint
/setTaxAutopayer

### Parameters
#### Request Body
- **uuid** (UUID) - Required - The UUID of the player to set as the autopayer.

### Response
#### Success Response (200)
- **message** (string) - Confirmation of successful update.

### Request Example
{
  "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}

### Response Example
{
  "message": "Player set as tax autopayer successfully."
}
```

--------------------------------

### ArgName Constructor

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgName

Initializes a new instance of the ArgName class. This constructor is part of the class's public API and does not take any arguments.

```java
public ArgName()
```

--------------------------------

### Access Configuration Options (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

Provides methods to get and set the plugin's configuration options. This allows for dynamic modification of plugin behavior.

```java
PSConfig configOptions = getConfigOptions();
setConfigOptions(newConfig);
List<PSProtectBlock> configuredBlocks = getConfiguredBlocks();
```

--------------------------------

### Get Region Tenant (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSMergedRegion

Retrieves the UUID of the tenant currently associated with the region, if any.

```Java
public UUID getTenant()
```

--------------------------------

### Get Root Region - PSRegion

Source: https://jdps.espi.dev/dev/espi/protectionstones/PSGroupRegion

Retrieves the merged region that shares the same ID as the group region ID.

```java
public PSMergedRegion getRootRegion()
Get the merged region whose ID is the same as the group region ID. 

Returns:
    the root region
```

--------------------------------

### Get UUID from Base64 PSProtectBlock

Source: https://jdps.espi.dev/dev/espi/protectionstones/class-use/PSProtectBlock

Extracts a UUID from a Base64 encoded string representation of a PSProtectBlock.

```Java
static String
BlockUtil.getUUIDFromBase64PS(PSProtectBlock b)
```

--------------------------------

### Command Argument Management

Source: https://jdps.espi.dev/dev/espi/protectionstones/ProtectionStones

Provides methods to manage command arguments for the /ps command.

```APIDOC
## POST /ps/command-arguments

### Description
Adds a command argument to the /ps command.

### Method
POST

### Endpoint
/ps/command-arguments

### Parameters
#### Request Body
- **psca** (PSCommandArg) - Required - The PSCommandArg object to be added.

### Response
#### Success Response (200)
Indicates that the command argument was added successfully.

## GET /ps/command-arguments

### Description
Retrieves the list of command arguments for the /ps command.

### Method
GET

### Endpoint
/ps/command-arguments

### Response
#### Success Response (200)
- **commandArguments** (List<PSCommandArg>) - A list of PSCommandArg objects.

#### Response Example
```json
{
  "commandArguments": [
    {
      "name": "exampleArg",
      "description": "An example command argument"
    }
  ]
}
```
```

--------------------------------

### FlagHandler Method Details (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/FlagHandler

Provides specific details for the static methods in the FlagHandler class: getPlayerPlaceholderFlags returns a List of Strings, and initDefaultFlagPlaceholders initializes flags for a given player.

```java
public static List<String> getPlayerPlaceholderFlags()
public static void initDefaultFlagPlaceholders(HashMap<com.sk89q.worldguard.protection.flags.Flag<?>,Object> flags, org.bukkit.entity.Player p)
```

--------------------------------

### Get Default Protected Region

Source: https://jdps.espi.dev/dev/espi/protectionstones/class-use/PSProtectBlock

Creates a default WorldGuard ProtectedCuboidRegion using a PSProtectBlock and a PSLocation.

```Java
static com.sk89q.worldguard.protection.regions.ProtectedCuboidRegion
WGUtils.getDefaultProtectedRegion(PSProtectBlock b, PSLocation v)
```

--------------------------------

### Get Rent Flag Value

Source: https://jdps.espi.dev/index-all

Retrieves the value associated with a PSRentFlag. This method is part of the PSRentFlag enum.

```java
getVal() - Method in enum class dev.espi.protectionstones.PSRentFlag
     
```

--------------------------------

### ArgHelp Constructor Details (Java)

Source: https://jdps.espi.dev/dev/espi/protectionstones/commands/ArgHelp

Details the default constructor for the ArgHelp class.

```java
public ArgHelp()
```
Tokens:
Raw