Overview | EssentialsC | TabApi
net.godlycow.org.essc.api

Interface TabApi

public interface TabApi

API interface for interacting with EssentialsC's tab list system. Manages player tab list names, integrating with LuckPerms for prefixes/suffixes and TAB plugin when available. Handles AFK indicators and nickname display.

Retrieve an instance via EssentialsCAPI.getTabApi().

TabApi tab = APIProvider.getAPI().getTabApi();

tab.updatePlayerTab(player);

Method Summary

void updatePlayerTab(Player player)
Updates the tab list display for the given player.
void refreshAll()
Refreshes the tab list display for all online players.
boolean isLuckPermsEnabled()
Returns whether LuckPerms integration is enabled for tab formatting.
boolean isUsingTABPlugin()
Returns whether the TAB plugin is being used for tab management.
void reload()
Reloads the tab configuration from disk.
Method Detail
public void updatePlayerTab(Player player)

Updates the tab list display for the given player. Applies LuckPerms prefix/suffix, AFK status, and nickname if configured. Automatically delegates to TAB plugin if installed.

Warning: Must be called on the main thread.
Parameters:
playerthe player to update; must not be null
public void refreshAll()

Refreshes the tab list display for all online players. Iterates through all players and calls updatePlayerTab(Player) for each. Use sparingly to avoid performance impact.

Warning: Must be called on the main thread.
public boolean isLuckPermsEnabled()

Returns whether LuckPerms integration is enabled for tab formatting.

Returns:
booleantrue if LuckPerms is present and enabled in config
public boolean isUsingTABPlugin()

Returns whether the TAB plugin is being used for tab management.

Returns:
booleantrue if TAB plugin is installed and active
public void reload()

Reloads the tab configuration from disk. Re-reads config values and re-detects available plugins (LuckPerms, TAB).

Warning: Must be called on the main thread.