Foundry classes

The API Foundry gives an addon when it starts. It provides the plugin, ability registry, ability runner, player assignments, and item data service.

The required shape of an addon. An addon provides an ID and version, then registers its abilities in onEnable().

The required shape of an ability: an ID, an activate() function, and an optional cooldown.

The player and ability ID passed to an ability when Foundry runs it.

Lets addons register, find, list, and remove abilities.

Runs an ability by ID. It returns false if the ability is missing or the player is on cooldown.

Saves which ability a player uses for each click action.

Saves or reads an ability ID on an item. This does not make the item activate the ability yet.

The eight supported clicks: left or right, main hand or offhand, while sneaking or not sneaking.

The main Paper plugin. It creates the API, listens for player clicks, and loads addons when the server starts.

Builds the API and connects it to the plugin's ability and data services.

Keeps registered abilities in a map, rejects blank or duplicate IDs, and lets the API look them up.

Finds the requested ability, checks the player's cooldown, runs it, and starts its next cooldown.

Stores player-to-action ability assignments in each player's saved data.

Stores an ability ID in an item's saved data. It only stores the ID; it does not trigger the ability.

Finds JAR files in plugins/Foundry/packs, reads each foundry.yml, loads the addon class, and calls onEnable().

An internal record holding a loaded addon and the class loader that opened its JAR.

Wraps a loaded addon and exposes its ID, version, and shutdown callback to the loader.

Checks player click events for an assigned ability and asks the ability service to run it.

Keeps cooldown end times in memory for each player and ability, and can read or clear them.