EssentialsC API — Overview

The EssentialsC API lets other plugins interact with EssentialsC systems at runtime. Retrieve the root API instance via APIProvider.getAPI() and navigate to the relevant sub-system interface.

EssentialsCAPI api = APIProvider.getAPI();
if (api != null) {
    boolean afk = api.getAFKApi().isAFK(player);
}

Add the api module as a compileOnly dependency and declare EssentialsC as a soft-depend or hard-depend in your plugin.yml.

API Sections

interface AFKApi	Read and manipulate the AFK state of players — check status, get durations, set or toggle AFK manually, and record activity from external plugins.
interface BackApi	Read and manipulate player back locations — check and set saved positions, trigger or cancel warmup teleports, manage cooldowns, and query back config settings.
ChatApi	interface	Chat formatting, color codes, and LuckPerms integration.
interface AuctionApi	Query active listings, player auctions, and transaction history. Programmatically create listings, process purchases, cancel auctions, and claim expired items.

Entry Points

interface `EssentialsCAPI`	Root interface. Returns each sub-system API.
class `APIProvider`	Static holder — call `APIProvider.getAPI()` to obtain the `EssentialsCAPI` instance.