All Classes and Interfaces

Class
Description
 
 
Fired when a player's AFK status changes.
The cause of the AFK status change.
 
 
 
 
Called during player login after the user's data has been loaded.
 
A class which provides numerous methods to interact with Essentials' balance top calculations.
This class represents a user's name/balance in the balancetop cache.
 
 
A Configurate type serializer for BigDecimals.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Used to indicate to Configurate that the annotated field should be treated as null if it is treated as incomplete.
 
 
Used to indicate to Configurate that the annotated field should be treated as null if it is a Collection, Map, or String that is empty.
 
This utility class is used for converting between the ingame time in ticks to ingame time as a friendly string.
Most of this code was "borrowed" from KyoriPowered/Adventure and is subject to their MIT license; MIT License Copyright (c) 2017-2020 KyoriPowered Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
You should use Vault instead of directly using this class.
Deprecated.
 
Abstraction layer for economy abstraction layers.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
parseFloat and parseDouble proxies that are protected against non-finite values.
Fired when a player's flight status is toggled using /fly.
 
 
Fired when a user's god status is toggled.
 
 
Manages EssentialsX's teleport functionality for a player.
 
 
This interface exposes certain extra methods implemented in the main class that are not implemented in IEssentials.
 
 
This event is currently unused, and is retained for ABI compatibility and potential future implementation.
Deprecated.
External plugins should prefer to use either the player's client language (Player.getLocale() or II18n in case of future additions.
Provides access to the current locale in use.
Deprecated.
External plugins should use IItemDb instead, which includes access to IItemDb.ItemResolver APIs.
Provides access to the current item alias registry, and allows registration of custom item resolvers.
A service capable of resolving custom item names to items and vice versa, as well as adding extra item names to tab complete suggestions.
Deprecated.
External plugins should use IJails instead of this interface in case future APIs are added.
This interface may contain future additions to the jails API on top of IJails.
Represents an interface for message recipients.
Deprecated.
This exception relates to the abandoned 3.x storage refactor and is not implemented.
Deprecated.
This exception relates to the abandoned 3.x storage refactor and is not implemented.
Deprecated.
This exception is unused.
Fired when trying to teleport a user to an invalid world.
 
 
 
 
 
 
 
Deprecated.
This API is not asynchronous and is no longer maintained.
Deprecated.
This API is not asynchronous.
 
Deprecated.
External plugins should use IUser instead of this interface, in case future APIs are added.
This interface may contain future additions to the warps API on top of IUser.
 
Deprecated.
External plugins should use IWarps instead of this interface, in case future APIs are added.
This interface may contain future additions to the warps API on top of IWarps.
 
Fired when a player's jail status changes.
 
 
Called when the player is given a kit
 
Represents a Location but doesn't parse the location until it is requested via LazyLocation.location().
 
Fired when a player uses local chat.
 
A Configurate type serializer for LazyLocations.
 
 
 
An immutable representation of a message sent as mail.
 
An entity which is allowed to send mail to an IUser.
This interface provides access to core Essentials mailing functions, allowing API users to send messages to IUser's.
 
 
 
 
Thrown when a transaction would put the player's balance above the maximum balance allowed.
 
 
 
 
 
 
 
 
 
 
 
Fired when a player's mute status is changed.
Fired when a player's nickname is changed.
 
Thrown when a user does not have the balance for a transaction and cannot take a loan.
Deprecated.
You should use NoLoanPermittedException instead of this class.
 
 
 
 
 
 
 
 
 
 
 
 
A namespaced key that uses plugins as namespaces.
 
Called before a player is teleported.
Called just before a private message is sent to its recipient
Called after a private message has been sent to its recipient.
 
 
 
 
 
 
 
Fired when an Essentials sign is broken.
 
 
Fired when an Essentials sign is created.
 
 
 
This handles common boilerplate for other SignEvent
 
 
 
 
 
 
Fired when an Essentials sign is interacted with.
 
 
 
 
Deprecated.
 
 
 
 
 
 
 
 
 
 
 
 
Represents a simple reusable implementation of IMessageRecipient.
 
 
 
This handles common boilerplate for events for changes in state.
This handles common boilerplate for events for changes in state that are boolean (true/false).
 
 
Deprecated.
This API is not asynchronous.
 
Abstract class for various teleport events.
Called when a player accepts or denies a teleport.
Called when a command starts a player's teleport warmup.
 
 
Deprecated.
 
Fired when a /tpa, /tpaall or /tpahere request is made.
 
 
 
Fired when a transaction (e.g.
A state that can be either true, false or unset.
 
 
Called when a user runs the /me command.
Fired when a user's balance updates.
The cause of the balance update.
 
 
 
Thrown when the requested user does not exist.
Deprecated.
This is unused - see UserDoesNotExistException.
Called when a user is kicked with the /kick command.
 
Called when the player uses the command /tpr
Called when a user is teleported home via the /home command.
The type of home location.
Called when the player use the command /warp
 
Fired when a player's vanish status changes due to the /vanish command.
A goddamn Vault adapter, what more do you want? Provides access to the EssentialsX economy for plugins that use the Vault API.
 
 
 
 
Called when a warp is about to be modified.
The cause of why a warp was modified.