EdDungeons API

The EdDungeons API provides comprehensive access to all EdDungeons plugin functionality, allowing developers to integrate with and extend the dungeon system.

Singleton Access Pattern

The EdDungeonsAPI uses a singleton pattern for easy access throughout your plugin:

// Get the main API instance
EdDungeonsAPI api = EdDungeonsAPI.getInstance();

// Access specific subsystem APIs
EdDungeonsCurrencyAPI currencyAPI = api.getCurrencyAPI();
EdDungeonsZonesAPI zonesAPI = api.getZonesAPI();

Main Interface Methods

API Access Methods

EdDungeonsEnchantAPI getEnchantAPI()

  • Description: Provides access to the enchantment system API

  • Returns: Interface for managing custom enchantments

  • Features: Enchant levels, costs, effects, player progress

EdDungeonsGuisAPI getGuisAPI()

  • Description: Provides access to the GUI management system

  • Returns: Interface for GUI creation and manipulation

  • Features: Dynamic GUIs, player-specific interfaces, menu systems

EdDungeonsSwordAPI getSwordAPI()

  • Description: Provides access to the sword progression system

  • Returns: Interface for sword management and upgrades

  • Features: Sword skins, tiers, damage calculations, player equipment

EdDungeonsZonesAPI getZonesAPI()

  • Description: Provides access to the zone management system

  • Returns: Interface for zone control and player progression

  • Features: Zone teleportation, stage management, mob spawning

EdDungeonsCurrencyAPI getCurrencyAPI()

  • Description: Provides access to the currency system

  • Returns: Interface for economy operations

  • Features: Balance management, transactions, multiple currencies

EdDungeonsLevelingAPI getLevelingAPI()

  • Description: Provides access to the leveling system

  • Returns: Interface for leveling operations

  • Features: Level management, transactions, multiple levels

EdDungeonsBoostersAPI getBoostersAPI()

  • Description: Provides access to the booster system

  • Returns: Interface for boost management

  • Features: Active boosts, multipliers, time-based effects

Last updated

Was this helpful?