RulesApi — EssentialsC API

API interface for interacting with EssentialsC's server rules system. Rules are loaded from rules.txt on startup and reload, parsed with MiniMessage formatting, and cached in memory. This API provides read-only access to the current rule set.

Retrieve an instance via EssentialsCAPI.getRulesApi().

RulesApi rules = APIProvider.getAPI().getRulesApi();

for (RuleEntry rule : rules.getRules()) {
    player.sendMessage(miniMessage.deserialize(rule.content()));
}

The RuleEntry record lives in the net.godlycow.org.essc.api.rules sub-package.

Method Summary

List<RuleEntry>	getRules() Returns a copy of the current rules list with MiniMessage formatting.
int	getRuleCount() Returns the number of loaded rules.
void	reload() Reloads the rules from disk and re-parses MiniMessage formatting.

Method Detail

public List<RuleEntry> getRules()

Returns a copy of the current rules list.

Each rule preserves its MiniMessage formatting. Returns an empty list if no rules are loaded.

Returns:

List<RuleEntry> a list of RuleEntry objects; never null

public int getRuleCount()

Returns the number of loaded rules.

Returns:

int	the rule count, or `0` if no rules are loaded

public void reload()

Reloads the rules from disk.

Re-reads rules.txt and re-parses all MiniMessage formatting.

Warning: Must be called on the main thread.

Interface RulesApi

Method Summary