EssentialsX API

https://jd-v2.essentialsx.net/
Admin
EssentialsX API provides classes, services, and events for developers to interact with and extend...
Tokens:60,635
Snippets:681
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### getInstance()

Source: https://jd-v2.essentialsx.net/index-all

Gets the singleton instance of the Console class.

```APIDOC
## getInstance()

### Description
Retrieves the single, globally accessible instance of the `Console` class, following the Singleton pattern.

### Method
Static Method Call

### Parameters
None

### Response
Returns the singleton `Console` instance.
```

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

### getName() - Kit

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the kit.

```APIDOC
## getName()

### Description
Gets the name of the kit.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The kit name.
```

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

### getPlayerLists(IEssentials, IUser, boolean)

Source: https://jd-v2.essentialsx.net/index-all

Gets lists of players based on Essentials instance, user, and a boolean flag. Static method in PlayerList.

```APIDOC
## getPlayerLists(IEssentials, IUser, boolean)

### Description
Retrieves lists of players, filtered by the provided IEssentials instance, IUser, and a boolean flag.

### Method
Static method in the com.earth2me.essentials.PlayerList class.

### Parameters
- **essentials** (IEssentials) - The Essentials instance.
- **user** (IUser) - The user context.
- **flag** (boolean) - A flag to control the player list retrieval.

### Response
- A list of player-related data.
```

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

### getName() - EssentialsCommand

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the Essentials command.

```APIDOC
## getName()

### Description
Gets the name of the Essentials command.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The command name.
```

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

### getPrice(IEssentials, ItemStack)

Source: https://jd-v2.essentialsx.net/index-all

Get the value of an item stack from the config.

```APIDOC
## getPrice(IEssentials, ItemStack)

### Description
Get the value of an item stack from the config.

### Method
Method signature

### Parameters
* **IEssentials** (type) - Required - Description of IEssentials parameter
* **ItemStack** (type) - Required - Description of ItemStack parameter

### Response
* **(type)** - Description of return value
```

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

### TeleportWarmupEvent

Source: https://jd-v2.essentialsx.net/index-all

Called when a command starts a player's teleport warmup.

```APIDOC
## TeleportWarmupEvent

### Description
Called when a command starts a player's teleport warmup.

### Constructors
`TeleportWarmupEvent(IUser user, IUser target, PlayerTeleportEvent.TeleportCause cause, ITarget targetInfo, double warmup)`
`TeleportWarmupEvent(IUser user, PlayerTeleportEvent.TeleportCause cause, ITarget targetInfo, double warmup)`
```

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

### getMatchingItems(String)

Source: https://jd-v2.essentialsx.net/index-all

Gets a list of tab-completable items usable for 'getMatching'.

```APIDOC
## getMatchingItems(String)

### Description
Gets a list of tab-completable items usable for "getMatching".

### Method
N/A (Method in class)

### Endpoint
N/A
```

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

### IItemDb.getResolvers()

Source: https://jd-v2.essentialsx.net/index-all

Get all registered resolvers.

```APIDOC
## IItemDb.getResolvers()

### Description
Get all registered resolvers.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Response
- **Map<String, Function>**: A map of all registered resolvers.
```

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

### Configuration and Backup

Source: https://jd-v2.essentialsx.net/index-all

Methods for managing configuration settings and backups.

```APIDOC
## Configuration and Backup

### EssentialsConfiguration.setProperty(String, boolean)


### Backup.setPendingShutdown(boolean)

```

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

### getBackup

Source: https://jd-v2.essentialsx.net/index-all

Initiates or retrieves backup information. Available in the Essentials class and IEssentials interface.

```APIDOC
## getBackup()

### Description
Initiates or retrieves backup information.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A (Specific return type not detailed)
```

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

### getRecipient()

Source: https://jd-v2.essentialsx.net/index-all

Gets the recipient of this mail.

```APIDOC
## getRecipient()

### Description
Gets the recipient of this mail.

### Method
Method signature

### Parameters
None

### Response
* **(type)** - Description of return value (recipient)
```

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

### getHandlerList Method

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/events/asyncuserdataloadevent

Gets the static handler list for all instances of this event.

```APIDOC
## getHandlerList

### Description
Returns the static handler list for the AsyncUserDataLoadEvent.

### Returns
- **HandlerList** - The static handler list.
```

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

### getPlugins(Server)

Source: https://jd-v2.essentialsx.net/index-all

Lists all plugin names on the server. This is a method in EssentialsCommand.

```APIDOC
## getPlugins(Server)

### Description
Lists the names of all plugins currently loaded on the server.

### Method
Method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.

### Response
- A list of strings, where each string is the name of a plugin.
```

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

### HelpopMessageSendEvent.getSender()

Source: https://jd-v2.essentialsx.net/index-all

Gets the sender of the helpop message.

```APIDOC
## HelpopMessageSendEvent.getSender()

### Description
Gets the sender of the helpop message.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Response
- **CommandSource**: The source that sent the helpop message.
```

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

### getName() - MailSender

Source: https://jd-v2.essentialsx.net/index-all

Gets the username of this MailSender.

```APIDOC
## getName()

### Description
Gets the username of this `MailSender`.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The username of the mail sender.
```

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

### UserConfigHolder - Accepting Pay

Source: https://jd-v2.essentialsx.net/index-all

Methods to check or set whether a user is accepting payments.

```APIDOC
## UserConfigHolder.acceptingPay()

### Description
Checks if the user is currently accepting payments.

### Method
Instance method

### Parameters
(None)

### Response
- **boolean** - True if accepting payments, false otherwise.

## UserConfigHolder.acceptingPay(boolean)

### Description
Sets whether the user is accepting payments.

### Method
Instance method

### Parameters
- **accepting** (boolean) - Required - True to accept payments, false otherwise.

### Response
(No specific response details provided in source)
```

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

### getBackupCommand

Source: https://jd-v2.essentialsx.net/index-all

Retrieves the command string used for backups. Available in ISettings interface and Settings class.

```APIDOC
## getBackupCommand()

### Description
Retrieves the command string configured for initiating backups.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **String**: The backup command.
```

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

### getName() - User

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the user.

```APIDOC
## getName()

### Description
Gets the name of the user.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The user's name.
```

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

### Settings Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods for accessing and checking Essentials settings.

```APIDOC
## isChatQuestionEnabled()

### Description
Checks if the chat question feature is enabled.

### Method
Method

### Signature
isChatQuestionEnabled()

### Interface
com.earth2me.essentials.ISettings
```

```APIDOC
## isChatQuestionEnabled()

### Description
Checks if the chat question feature is enabled.

### Method
Method

### Signature
isChatQuestionEnabled()

### Class
com.earth2me.essentials.Settings
```

```APIDOC
## isCommandCooldownPersistent(String)

### Description
Checks if command cooldowns are persistent for a specific command.

### Method
Method

### Signature
isCommandCooldownPersistent(String)

### Parameters
#### Path Parameters
- **commandName** (String) - Required - The name of the command.

### Interface
com.earth2me.essentials.ISettings
```

```APIDOC
## isCommandCooldownPersistent(String)

### Description
Checks if command cooldowns are persistent for a specific command.

### Method
Method

### Signature
isCommandCooldownPersistent(String)

### Parameters
#### Path Parameters
- **commandName** (String) - Required - The name of the command.

### Class
com.earth2me.essentials.Settings
```

```APIDOC
## isCommandCooldownsEnabled()

### Description
Checks if command cooldowns are globally enabled.

### Method
Method

### Signature
isCommandCooldownsEnabled()

### Interface
com.earth2me.essentials.ISettings
```

```APIDOC
## isCommandCooldownsEnabled()

### Description
Checks if command cooldowns are globally enabled.

### Method
Method

### Signature
isCommandCooldownsEnabled()

### Class
com.earth2me.essentials.Settings
```

```APIDOC
## isCommandDisabled(IEssentialsCommand)

### Description
Checks if a specific command is disabled.

### Method
Method

### Signature
isCommandDisabled(IEssentialsCommand)

### Parameters
#### Path Parameters
- **command** (IEssentialsCommand) - Required - The command to check.

### Interface
com.earth2me.essentials.ISettings
```

```APIDOC
## isCommandDisabled(IEssentialsCommand)

### Description
Checks if a specific command is disabled.

### Method
Method

### Signature
isCommandDisabled(IEssentialsCommand)

### Parameters
#### Path Parameters
- **command** (IEssentialsCommand) - Required - The command to check.

### Class
com.earth2me.essentials.Settings
```

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

### getName() - Console

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the console.

```APIDOC
## getName()

### Description
Gets the name of the console.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The console name.
```

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

### IItemDb.isReady()

Source: https://jd-v2.essentialsx.net/index-all

Deprecated. Checks if the item database is loaded and ready for use.

```APIDOC
## IItemDb.isReady()

### Description
Deprecated. Check whether the item database is loaded and ready for use.

### Method
`isReady()`

### Interface
`com.earth2me.essentials.api.IItemDb`
```

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

### TeleportRequestResponseEvent.getRequester()

Source: https://jd-v2.essentialsx.net/index-all

Gets the user who submitted this teleport request.

```APIDOC
## TeleportRequestResponseEvent.getRequester()

### Description
Gets the user who submitted this teleport request.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
- **User**: The user who submitted the teleport request.
```

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

### setEss

Source: https://jd-v2.essentialsx.net/index-all

Sets the Essentials instance for the Economy class.

```APIDOC
## setEss(IEssentials)

### Description
Sets the Essentials instance for the Economy class.

### Method
Static method

### Parameters
- **IEssentials**: The Essentials instance.
```

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

### getName() - PasteFile

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the paste file.

```APIDOC
## getName()

### Description
Gets the name of the paste file.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The file name.
```

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

### getName() - EssentialsSign

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the Essentials sign.

```APIDOC
## getName()

### Description
Gets the name of the Essentials sign.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The sign name.
```

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

### getMap()

Source: https://jd-v2.essentialsx.net/index-all

Retrieves the configuration map.

```APIDOC
## getMap()

### Description
Retrieves the configuration map.

### Method
N/A (Method in class)

### Endpoint
N/A
```

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

### getName() - PermissionsHandler

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the permissions handler.

```APIDOC
## getName()

### Description
Gets the name of the permissions handler.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The permissions handler name.
```

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

### Essentials Configuration Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods for accessing Essentials configuration settings.

```APIDOC
## isBoolean(String)

### Description
Checks if a string can be parsed as a boolean.

### Method
Method

### Signature
isBoolean(String)

### Parameters
#### Path Parameters
- **value** (String) - Required - The string to check.

### Class
com.earth2me.essentials.config.EssentialsConfiguration
```

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

### getName() - EconomyLayer

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the economy layer.

```APIDOC
## getName()

### Description
Gets the name of the economy layer.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The economy layer name.
```

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

### Settings Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods for accessing and modifying server settings.

```APIDOC
## getListGroupConfig()

### Description
Retrieves the configuration for listed groups.

### Method
Method

### Signature
`getListGroupConfig()`

### Interface
`com.earth2me.essentials.ISettings`
```

```APIDOC
## getLocale()

### Description
Retrieves the current server locale.

### Method
Method

### Signature
`getLocale()`

### Interface
`com.earth2me.essentials.ISettings`
```

```APIDOC
## getLoginAttackDelay()

### Description
Retrieves the delay configured for login attack prevention.

### Method
Method

### Signature
`getLoginAttackDelay()`

### Interface
`com.earth2me.essentials.ISettings`
```

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

### now(Player, boolean, PlayerTeleportEvent.TeleportCause, CompletableFuture)

Source: https://jd-v2.essentialsx.net/index-all

Initiates an asynchronous teleport for a player, allowing for custom delay handling and completion callbacks. Used to skip teleportPlayer delay when teleporting someone to a location or player.

```APIDOC
## now(Player, boolean, PlayerTeleportEvent.TeleportCause, CompletableFuture)

### Description
Initiates an asynchronous teleport for a player. This method is useful for skipping teleport delays and handling teleport completion via a CompletableFuture.

### Method
N/A (Asynchronous method call)

### Parameters
*   **player** (Player) - The player to teleport.
*   **arg1** (boolean) - Likely indicates whether to skip delay or checks, specific usage not detailed.
*   **cause** (PlayerTeleportEvent.TeleportCause) - The cause of the teleport event.
*   **future** (CompletableFuture) - A future to be completed upon teleport completion.
```

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

### getMessage() - HelpopMessageSendEvent

Source: https://jd-v2.essentialsx.net/index-all

Gets the helpop message to be sent.

```APIDOC
## getMessage(HelpopMessageSendEvent)

### Description
Gets the helpop message to be sent.

### Method
N/A (Method in class)

### Endpoint
N/A
```

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

### getBalanceTopCache

Source: https://jd-v2.essentialsx.net/index-all

Gets the balance top cache or an empty list if one has not been calculated yet. Available in BalanceTopImpl class and BalanceTop interface.

```APIDOC
## getBalanceTopCache()

### Description
Gets the balance top cache or an empty list if one has not been calculated yet.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **List**: A list of balance top entries.
```

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

### getBalanceTopTotal

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/services/balancetop

Gets the total amount of money in the economy at the point of the last balance top cache calculation or returns zero if no baltop calculation has been made as of yet.

```APIDOC
## getBalanceTopTotal

### Description
Gets the total amount of money in the economy at the point of the last balance top cache calculation.

### Method
`BigDecimal`

### Returns
The total amount of money in the economy or zero.
```

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

### Economy API Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods for managing user balances and setting prices.

```APIDOC
## Economy API

### setMoney(User, BigDecimal)

Sets the balance of a user.

### setMoney(UUID, BigDecimal)

Sets the balance of a user.

### setMoney(String, double)

Deprecated. Use `Economy.setMoney(UUID, BigDecimal)` or `Economy.setMoney(User, BigDecimal)`.

### setMoney(String, BigDecimal)

Deprecated. Usernames can change use `Economy.setMoney(UUID, BigDecimal)` or `Economy.setMoney(User, BigDecimal)`.

### Worth.setPrice(IEssentials, ItemStack, double)

Set the price of an item and save it to the config.
```

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

### getBalanceTopCache

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/services/balancetop

Gets the balance top cache or an empty list if one has not been calculated yet. The balance top cache is a Map which maps the UUID of the player to a BalanceTop.Entry object which stores the user's display name and balance. The returned map is sorted by greatest to least wealth. There is no guarantee the returned cache is up to date. The balancetop command is directly responsible for updating this cache and does so every two minutes (if executed). See calculateBalanceTopMapAsync() to manually update this cache yourself.

```APIDOC
## getBalanceTopCache

### Description
Gets the balance top cache or an empty list if one has not been calculated yet. The returned map is sorted by greatest to least wealth.

### Method
`Map<UUID, BalanceTop.Entry>`

### Returns
The balance top cache.
```

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

### now(Location, boolean, PlayerTeleportEvent.TeleportCause, CompletableFuture)

Source: https://jd-v2.essentialsx.net/index-all

Initiates an asynchronous teleport for a player to a specified location, allowing for custom delay handling and completion callbacks. Used to skip teleportPlayer delay when teleporting someone to a location or player.

```APIDOC
## now(Location, boolean, PlayerTeleportEvent.TeleportCause, CompletableFuture)

### Description
Initiates an asynchronous teleport for a player to a specific location. This method is useful for skipping teleport delays and handling teleport completion via a CompletableFuture.

### Method
N/A (Asynchronous method call)

### Parameters
*   **location** (Location) - The destination location for the teleport.
*   **arg1** (boolean) - Likely indicates whether to skip delay or checks, specific usage not detailed.
*   **cause** (PlayerTeleportEvent.TeleportCause) - The cause of the teleport event.
*   **future** (CompletableFuture) - A future to be completed upon teleport completion.
```

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

### getHomeOwner()

Source: https://jd-v2.essentialsx.net/index-all

Gets the owner of the home being modified in a HomeModifyEvent.

```APIDOC
## getHomeOwner()

### Description
In the context of a `HomeModifyEvent`, this method retrieves the owner of the home that is undergoing modification.

### Method
N/A (Method Call)

### Parameters
None

### Response
Returns the owner of the home (likely a `User` object or similar identifier).
```

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

### BalanceTop Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods related to calculating and managing the balance top list.

```APIDOC
## isCacheLocked()

### Description
Checks to see if the balance top cache is currently locked, indicating an ongoing calculation.

### Method
Method

### Signature
isCacheLocked()

### Class
com.earth2me.essentials.BalanceTopImpl
```

```APIDOC
## isCacheLocked()

### Description
Checks to see if the balance top cache is currently locked, indicating an ongoing calculation.

### Method
Method

### Signature
isCacheLocked()

### Interface
net.essentialsx.api.v2.services.BalanceTop
```

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

### getTimeExpire()

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/services/mail/mailmessage

Gets the millisecond epoch at which this message will expire.

```APIDOC
## getTimeExpire()

### Description
Gets the millisecond epoch at which this message will expire and no longer been shown to the user.

### Method
GET

### Endpoint
N/A (Instance Method)

### Returns
- **long** - The epoch time when the message will expire.
```

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

### setHome

Source: https://jd-v2.essentialsx.net/index-all

Deprecated. Sets a home for a user.

```APIDOC
## setHome

### Description
Deprecated. Sets a home for a user.

### Method
N/A (Method signature provided)

### Signature
`setHome(String homeName, Location location)`

### Parameters
- **homeName** (String) - The name of the home.
- **location** (Location) - The location to set the home to.
```

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

### getHandlers Method

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/events/asyncuserdataloadevent

Gets the handler list for this event.

```APIDOC
## getHandlers

### Description
Retrieves the list of handlers for this event.

### Returns
- **HandlerList** - The handler list.
```

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

### IItemDb.getResolvers(Plugin)

Source: https://jd-v2.essentialsx.net/index-all

Get all registered resolvers from the given plugin.

```APIDOC
## IItemDb.getResolvers(Plugin)

### Description
Get all registered resolvers from the given plugin.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
- **plugin** (Plugin) - Required - The plugin to get resolvers from.

### Response
- **Map<String, Function>**: A map of registered resolvers from the specified plugin.
```

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

### getBuildInfo()

Source: https://jd-v2.essentialsx.net/index-all

Retrieves build information from the UpdateChecker class.

```APIDOC
## getBuildInfo()

### Description
Retrieves information about the current build of the plugin.

### Method
GET (assumed)

### Endpoint
Not specified, likely an internal method call.

### Parameters
None

### Request Example
None

### Response
- **BuildInfo**: The build information (type not specified).
```

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

### getPlayer(Server, String[], int, boolean, boolean)

Source: https://jd-v2.essentialsx.net/index-all

Finds a player by name using multiple arguments, an index, and two boolean flags. Static method in EssentialsCommand.

```APIDOC
## getPlayer(Server, String[], int, boolean, boolean)

### Description
Finds a player by name using multiple arguments, an index, and two boolean flags.

### Method
Static method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.
- **args** (String[]) - An array of arguments potentially containing the player name.
- **index** (int) - The index in the arguments array where the player name is expected.
- **allowOffline** (boolean) - Whether to allow finding offline players.
- **allowConsole** (boolean) - Whether to allow finding players via console input.

### Response
- The Player object if found, otherwise null.
```

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

### TeleportRequestResponseEvent.getRequestee()

Source: https://jd-v2.essentialsx.net/index-all

Gets the user who is accepting or denying this teleport request.

```APIDOC
## TeleportRequestResponseEvent.getRequestee()

### Description
Gets the user who is accepting or denying this teleport request.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
- **User**: The user who accepted or denied the request.
```

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

### LocationUtil.getSafeDestination(IUser, Location)

Source: https://jd-v2.essentialsx.net/index-all

Deprecated. Use `LocationUtil.getSafeDestination(IEssentials, IUser, Location)`.

```APIDOC
## LocationUtil.getSafeDestination(IUser, Location)

### Description
Deprecated. Use `LocationUtil.getSafeDestination(IEssentials, IUser, Location)`.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
- **user** (IUser) - Required - The user for whom to find a safe destination.
- **location** (Location) - Required - The desired location.

### Response
- **Location**: A safe destination location near the desired location.
```

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

### getRecipients()

Source: https://jd-v2.essentialsx.net/index-all

Gets a set of recipients that this chat message will be displayed to.

```APIDOC
## getRecipients()

### Description
Gets a set of recipients that this chat message will be displayed to.

### Method
Method signature

### Parameters
None

### Response
* **Set<(type)>** - Description of return value (set of recipients)
```

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

### getNames() - CustomItemResolver

Source: https://jd-v2.essentialsx.net/index-all

Gets all recognized names for custom items.

```APIDOC
## getNames()

### Description
Gets all recognized names for custom items.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Set<String>** - A set of custom item names.
```

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

### getPlayer(Server, CommandSource, String[], int)

Source: https://jd-v2.essentialsx.net/index-all

Finds a player by name with additional context and an index. Static method in EssentialsCommand.

```APIDOC
## getPlayer(Server, CommandSource, String[], int)

### Description
Finds a player by name, considering multiple arguments and an index, with context from a CommandSource.

### Method
Static method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.
- **source** (CommandSource) - The source of the command.
- **args** (String[]) - An array of arguments potentially containing the player name.
- **index** (int) - The index in the arguments array where the player name is expected.

### Response
- The Player object if found, otherwise null.
```

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

### getName() - SimpleMessageRecipient

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the simple message recipient.

```APIDOC
## getName()

### Description
Gets the name of the simple message recipient.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The recipient's name.
```

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

### getPlayer(Server, CommandSource, String[], int, boolean)

Source: https://jd-v2.essentialsx.net/index-all

Finds a player by name with additional context, index, and a boolean flag. Static method in EssentialsCommand.

```APIDOC
## getPlayer(Server, CommandSource, String[], int, boolean)

### Description
Finds a player by name using multiple arguments, an index, and a boolean flag, with context from a CommandSource.

### Method
Static method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.
- **source** (CommandSource) - The source of the command.
- **args** (String[]) - An array of arguments potentially containing the player name.
- **index** (int) - The index in the arguments array where the player name is expected.
- **allowOffline** (boolean) - Whether to allow finding offline players.

### Response
- The Player object if found, otherwise null.
```

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

### getName() - VaultEconomyProvider

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the Vault economy provider.

```APIDOC
## getName()

### Description
Gets the name of the Vault economy provider.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The economy provider name.
```

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

### createNPC

Source: https://jd-v2.essentialsx.net/index-all

Creates dummy files for a non-player character (NPC) if no player with that name currently exists. This is useful for setting up NPC-related data.

```APIDOC
## createNPC(String)

### Description
Creates dummy files for an NPC. If a player with the given name already exists, this method may not create new files.

### Method
Method

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the NPC for whom to create dummy files.
```

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

### getName() - VaultLayer

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the Vault economy layer.

```APIDOC
## getName()

### Description
Gets the name of the Vault economy layer.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The Vault layer name.
```

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

### getAnnounceNewPlayerFormat

Source: https://jd-v2.essentialsx.net/index-all

Retrieves the format string used for announcing new player joins. This method is available in both the ISettings interface and the Settings class.

```APIDOC
## getAnnounceNewPlayerFormat()

### Description
Retrieves the format string used for announcing new player joins.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
- **String**: The format string for new player announcements.
```

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

### getMessage() - UserMailEvent

Source: https://jd-v2.essentialsx.net/index-all

Gets the underlying MailMessage for this mail event.

```APIDOC
## getMessage()

### Description
Gets the underlying `MailMessage` for this mail.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **MailMessage** - The underlying mail message object.
```

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

### getPlayer(Server, User, String[], int, boolean)

Source: https://jd-v2.essentialsx.net/index-all

Finds a player by name with additional context, index, and a boolean flag, using a User object. Static method in EssentialsCommand.

```APIDOC
## getPlayer(Server, User, String[], int, boolean)

### Description
Finds a player by name using multiple arguments, an index, and a boolean flag, with context from a User object.

### Method
Static method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.
- **user** (User) - The user context.
- **args** (String[]) - An array of arguments potentially containing the player name.
- **index** (int) - The index in the arguments array where the player name is expected.
- **allowOffline** (boolean) - Whether to allow finding offline players.

### Response
- The Player object if found, otherwise null.
```

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

### getMessage() - UserActionEvent

Source: https://jd-v2.essentialsx.net/index-all

Gets the message associated with a user action.

```APIDOC
## getMessage(UserActionEvent)

### Description
Gets the message associated with a user action.

### Method
N/A (Method in class)

### Endpoint
N/A
```

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

### KitPreExpandItemsEvent

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/events/package-tree

Fired just before the items in a kit are expanded. This event allows for manipulation of the items that will be given to the player.

```APIDOC
## KitPreExpandItemsEvent

### Description
This event is triggered immediately before the items within a kit are expanded and given to a player. It provides an opportunity to modify the item list.

### Class
net.essentialsx.api.v2.events.KitPreExpandItemsEvent

### Usage
Use this event to alter the items a player receives from a kit.

```java
@EventHandler
public void onKitPreExpandItems(KitPreExpandItemsEvent event) {
    // Modify the list of items to be expanded
    // event.getItems().add(new ItemStack(Material.DIAMOND));
}
```
```

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

### nowAsync(IUser, ITarget, PlayerTeleportEvent.TeleportCause, CompletableFuture)

Source: https://jd-v2.essentialsx.net/index-all

An asynchronous method for teleporting a user to a target, with a specified cause and a completion future.

```APIDOC
## nowAsync(IUser, ITarget, PlayerTeleportEvent.TeleportCause, CompletableFuture)

### Description
Initiates an asynchronous teleport for a user to a target. This method allows for custom delay handling and completion callbacks via a CompletableFuture.

### Method
N/A (Asynchronous method call)

### Parameters
*   **user** (IUser) - The user to be teleported.
*   **target** (ITarget) - The destination for the teleport.
*   **cause** (PlayerTeleportEvent.TeleportCause) - The cause of the teleport event.
*   **future** (CompletableFuture) - A future to be completed upon teleport completion.
```

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

### getMessage() - ChatEvent

Source: https://jd-v2.essentialsx.net/index-all

Gets the message that the player is attempting to send.

```APIDOC
## getMessage(ChatEvent)

### Description
Gets the message that the player is attempting to send.

### Method
N/A (Method in class)

### Endpoint
N/A
```

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

### getMessage() - TranslatableException

Source: https://jd-v2.essentialsx.net/index-all

Gets the message content of a translatable exception.

```APIDOC
## getMessage(TranslatableException)

### Description
Gets the message content of a translatable exception.

### Method
N/A (Method in exception class)

### Endpoint
N/A
```

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

### Essentials Core Methods

Source: https://jd-v2.essentialsx.net/index-all

Core methods for interacting with the Essentials plugin.

```APIDOC
## getMail()

### Description
Retrieves the mail system from the Essentials plugin.

### Method
Method

### Signature
`getMail()`

### Class
`com.earth2me.essentials.Essentials`
```

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

### getTimeSent()

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/services/mail/mailmessage

Gets the millisecond epoch time when the message was sent.

```APIDOC
## getTimeSent()

### Description
Gets the millisecond epoch time when the message was sent.

### Method
GET

### Endpoint
N/A (Instance Method)

### Returns
- **long** - The epoch time when message was sent.
```

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

### Add Kit to Essentials

Source: https://jd-v2.essentialsx.net/index-all

Adds a new kit to the Essentials system, specifying its name, the items it contains, and its cooldown period.

```java
addKit(String, List, long)
Adds a kit.
```

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

### Accepting Pay Configuration

Source: https://jd-v2.essentialsx.net/index-all

Methods to check and set the 'acceptingPay' status for a user, controlling whether they can receive payments.

```java
acceptingPay()
Checks if the user is accepting pay.
```

```java
acceptingPay(boolean)
Sets whether the user is accepting pay.
```

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

### getUserCount()

Source: https://jd-v2.essentialsx.net/index-all

Gets the total number of users currently stored by Essentials.

```APIDOC
## getUserCount()

### Description
Returns the total count of users managed by Essentials.

### Method
Not applicable (Java method)

### Endpoint
Not applicable (Java method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```java
// Example usage in Java
int userCount = essentials.getUserMap().getUserCount();
```

### Response
#### Success Response
- **Integer** (int) - The total number of users.

#### Response Example
```
150
```
```

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

### MailMessage.getSenderUsername()

Source: https://jd-v2.essentialsx.net/index-all

Gets the sender's username at the time of sending the message.

```APIDOC
## MailMessage.getSenderUsername()

### Description
Gets the sender's username at the time of sending the message.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Response
- **String**: The username of the sender.
```

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

### getMinMoney() - ISettings

Source: https://jd-v2.essentialsx.net/index-all

Retrieves the minimum money threshold from settings.

```APIDOC
## getMinMoney()

### Description
Retrieves the minimum money threshold.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **double** - The minimum money threshold.
```

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

### getPlayer(Server, User, String[], int)

Source: https://jd-v2.essentialsx.net/index-all

Finds a player by name with additional context and an index, using a User object. Static method in EssentialsCommand.

```APIDOC
## getPlayer(Server, User, String[], int)

### Description
Finds a player by name, considering multiple arguments and an index, with context from a User object.

### Method
Static method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.
- **user** (User) - The user context.
- **args** (String[]) - An array of arguments potentially containing the player name.
- **index** (int) - The index in the arguments array where the player name is expected.

### Response
- The Player object if found, otherwise null.
```

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

### getNames() - IItemDb.ItemResolver

Source: https://jd-v2.essentialsx.net/index-all

Get all possible names that are recognized by this item resolver.

```APIDOC
## getNames()

### Description
Get all possible names that are recognized by this item resolver.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Set<String>** - A set of recognized item names.
```

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

### Configuration Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods related to command cooldowns and configuration processing.

```APIDOC
## isIncomplete()

### Description
Checks if the command cooldown configuration is incomplete.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

```APIDOC
## isIncomplete()

### Description
Checks if the entity is incomplete, typically used in configuration processing.

### Method
N/A (Method Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```

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

### getInventory(Player, boolean)

Source: https://jd-v2.essentialsx.net/index-all

Retrieves a player's inventory, with an option to include specific data.

```APIDOC
## getInventory(Player player, boolean includeData)

### Description
Retrieves the inventory of a given player. The boolean parameter controls whether additional data is included.

### Method
N/A (Method Call)

### Parameters
#### Path Parameters
- **player** (Player) - Required - The player whose inventory is to be retrieved.
- **includeData** (boolean) - Required - A flag to determine if extra inventory data should be included.

### Response
Returns the player's inventory object.
```

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

### getNameCache() - IUserMap

Source: https://jd-v2.essentialsx.net/index-all

Gets the name to UUID cache from the user map.

```APIDOC
## getNameCache()

### Description
Gets the name to UUID cache.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **Map<String, UUID>** - The name to UUID cache.
```

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

### ISettings.warnOnBuildDisallow

Source: https://jd-v2.essentialsx.net/index-all

Checks if warnings should be issued when build is disallowed.

```APIDOC
## warnOnBuildDisallow()

### Description
Checks if warnings should be issued when build is disallowed.

### Method
ISettings.warnOnBuildDisallow

### Returns
(boolean) - True if warnings should be issued, false otherwise.
```

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

### getMinor() - BukkitVersion

Source: https://jd-v2.essentialsx.net/index-all

Gets the minor version component of a Bukkit version.

```APIDOC
## getMinor()

### Description
Gets the minor version component.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **int** - The minor version number.
```

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

### getMaterialName(CommandSource, Material)

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the material for a given Material.

```APIDOC
## getMaterialName(CommandSource, Material)

### Description
Gets the name of the material for a given `Material`.

### Method
N/A (Method in class)

### Endpoint
N/A
```

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

### getPlayer(Server, String, boolean, boolean)

Source: https://jd-v2.essentialsx.net/index-all

Finds a player by name with two boolean flags. Static method in EssentialsCommand.

```APIDOC
## getPlayer(Server, String, boolean, boolean)

### Description
Finds a player by name using a string and two boolean flags.

### Method
Static method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.
- **name** (String) - The name of the player to find.
- **allowOffline** (boolean) - Whether to allow finding offline players.
- **allowConsole** (boolean) - Whether to allow finding players via console input.

### Response
- The Player object if found, otherwise null.
```

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

### getMaterialName(CommandSource, ItemStack)

Source: https://jd-v2.essentialsx.net/index-all

Gets the name of the material for a given ItemStack.

```APIDOC
## getMaterialName(CommandSource, ItemStack)

### Description
Gets the name of the material for a given `ItemStack`.

### Method
N/A (Method in class)

### Endpoint
N/A
```

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

### now(Player, boolean, PlayerTeleportEvent.TeleportCause)

Source: https://jd-v2.essentialsx.net/index-all

Initiates a synchronous teleport for a player to a specified location or another player. This method is deprecated.

```APIDOC
## now(Player, boolean, PlayerTeleportEvent.TeleportCause)

### Description
Initiates a synchronous teleport for a player. This method is deprecated and should be replaced with asynchronous alternatives.

### Method
N/A (Synchronous method call)

### Parameters
*   **player** (Player) - The player to teleport.
*   **arg1** (boolean) - Likely indicates whether to skip delay or checks, specific usage not detailed.
*   **cause** (PlayerTeleportEvent.TeleportCause) - The cause of the teleport event.

### Deprecated
This method is deprecated.
```

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

### now(Location, boolean, PlayerTeleportEvent.TeleportCause)

Source: https://jd-v2.essentialsx.net/index-all

Initiates a synchronous teleport for a player to a specified location. This method is deprecated.

```APIDOC
## now(Location, boolean, PlayerTeleportEvent.TeleportCause)

### Description
Initiates a synchronous teleport for a player to a specific location. This method is deprecated and should be replaced with asynchronous alternatives.

### Method
N/A (Synchronous method call)

### Parameters
*   **location** (Location) - The destination location for the teleport.
*   **arg1** (boolean) - Likely indicates whether to skip delay or checks, specific usage not detailed.
*   **cause** (PlayerTeleportEvent.TeleportCause) - The cause of the teleport event.

### Deprecated
This method is deprecated.
```

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

### getSenderUUID()

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/services/mail/mailmessage

Gets the sender's UUID or null if the sender does not have a UUID.

```APIDOC
## getSenderUUID()

### Description
Gets the sender's `UUID` or null if the sender does not have a UUID.

### Method
GET

### Endpoint
N/A (Instance Method)

### Returns
- **UUID** - The sender's `UUID` or null.
```

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

### getSenderUsername()

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/services/mail/mailmessage

Gets the sender's username at the time of sending the message.

```APIDOC
## getSenderUsername()

### Description
Gets the sender's username at the time of sending the message.

### Method
GET

### Endpoint
N/A (Instance Method)

### Returns
- **String** - The sender's username.
```

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

### Get Player Involved

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/events/chat/chatevent

Returns the player who initiated the chat event.

```java
public final Player getPlayer()
```

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

### setBase

Source: https://jd-v2.essentialsx.net/index-all

Sets the base player for a player extension.

```APIDOC
## setBase(Player)

### Description
Sets the base player for a player extension.

### Method
Method

### Parameters
- **Player**: The player to set as the base.
```

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

### getPlayer(Server, CommandSource, String)

Source: https://jd-v2.essentialsx.net/index-all

Finds a player by name, with additional context. This is a static method in EssentialsCommand.

```APIDOC
## getPlayer(Server, CommandSource, String)

### Description
Attempts to find a player on the server using their name, with context from a CommandSource.

### Method
Static method in the com.earth2me.essentials.commands.EssentialsCommand class.

### Parameters
- **server** (Server) - The server instance.
- **source** (CommandSource) - The source of the command.
- **name** (String) - The name of the player to find.

### Response
- The Player object if found, otherwise null.
```

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

### Vault Economy Provider Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods for interacting with the Vault economy provider.

```APIDOC
## isBankMember(String, String)

### Description
Checks if a player is a member of a bank account.

### Method
Method

### Signature
isBankMember(String, String)

### Parameters
#### Path Parameters
- **accountName** (String) - Required - The name of the bank account.
- **playerName** (String) - Required - The name of the player.

### Class
com.earth2me.essentials.economy.vault.VaultEconomyProvider
```

```APIDOC
## isBankMember(String, OfflinePlayer)

### Description
Checks if a player is a member of a bank account.

### Method
Method

### Signature
isBankMember(String, OfflinePlayer)

### Parameters
#### Path Parameters
- **accountName** (String) - Required - The name of the bank account.
- **player** (OfflinePlayer) - Required - The offline player object.

### Class
com.earth2me.essentials.economy.vault.VaultEconomyProvider
```

```APIDOC
## isBankOwner(String, String)

### Description
Checks if a player is the owner of a bank account.

### Method
Method

### Signature
isBankOwner(String, String)

### Parameters
#### Path Parameters
- **accountName** (String) - Required - The name of the bank account.
- **playerName** (String) - Required - The name of the player.

### Class
com.earth2me.essentials.economy.vault.VaultEconomyProvider
```

```APIDOC
## isBankOwner(String, OfflinePlayer)

### Description
Checks if a player is the owner of a bank account.

### Method
Method

### Signature
isBankOwner(String, OfflinePlayer)

### Parameters
#### Path Parameters
- **accountName** (String) - Required - The name of the bank account.
- **player** (OfflinePlayer) - Required - The offline player object.

### Class
com.earth2me.essentials.economy.vault.VaultEconomyProvider
```

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

### Sign Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods for interacting with Essentials signs.

```APIDOC
## getLine(int)

### Description
Retrieves a specific line from an Essentials sign.

### Method
Method

### Signature
`getLine(int lineNumber)`

### Interface
`com.earth2me.essentials.signs.EssentialsSign.ISign`
```

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

### getName() - UserRandomTeleportEvent

Source: https://jd-v2.essentialsx.net/index-all

Gets the name associated with the user random teleport event.

```APIDOC
## getName()

### Description
Gets the name associated with the user random teleport event.

### Method
Method

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response
- **String** - The name associated with the event.
```

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

### ChatEvent Constructor

Source: https://jd-v2.essentialsx.net/net/essentialsx/api/v2/events/chat/chatevent

Initializes a new ChatEvent. Use this to create custom chat events.

```java
public ChatEvent(boolean async, ChatType chatType, Player player, String format, String message, Set<Player> recipients)
```

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

### getMoneyExact(UUID) - Economy

Source: https://jd-v2.essentialsx.net/index-all

Gets the exact balance of the account with the given UUID.

```APIDOC
## getMoneyExact(UUID)

### Description
Gets the exact balance of the account with the given UUID.

### Method
Static Method

### Endpoint
N/A

### Parameters
#### Path Parameters
- **UUID uuid** - The UUID of the player.

### Request Example
None

### Response
#### Success Response
- **double** - The exact balance of the user's account.
```

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

### Economy Methods

Source: https://jd-v2.essentialsx.net/index-all

Methods related to economy layers.

```APIDOC
## isLayerSelected()

### Description
Checks if an economy layer is currently selected.

### Method
Static method

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
N/A
```
Tokens:
Raw