Class ModuleAPI

java.lang.Object
net.blueva.arcade.api.ModuleAPI

public class ModuleAPI extends Object
Static API accessor for modules. Provides access to global APIs during onLoad().
  • Constructor Details

    • ModuleAPI

      public ModuleAPI()
  • Method Details

    • setProvider

      public static void setProvider(ModuleAPI.ModuleAPIProvider provider)
      Set the API provider (called by core plugin, DO NOT USE in modules).
    • getModuleConfig

      public static ModuleConfigAPI getModuleConfig(String moduleId)
      Get ModuleConfigAPI for a specific module. Returns null if module doesn't have config files.
      Parameters:
      moduleId - Module ID (e.g., "race")
      Returns:
      ModuleConfigAPI or null
    • getVoteMenuAPI

      public static VoteMenuAPI getVoteMenuAPI()
      Get VoteMenuAPI for registering games in vote menu.
      Returns:
      VoteMenuAPI instance
    • getMenuAPI

      public static MenuAPI getMenuAPI()
      Get MenuAPI for opening custom menus in Java and Bedrock.
      Returns:
      MenuAPI instance
    • getHytaleMenuAPI

      public static HytaleMenuAPI getHytaleMenuAPI()
      Get the experimental Hytale Menu API for HyUI-backed custom pages.

      This accessor may return null on non-Hytale platforms.

      Returns:
      HytaleMenuAPI instance or null
      Since:
      3.2
    • getStoreAPI

      public static StoreAPI getStoreAPI()
      Get StoreAPI for registering store categories and items.
      Returns:
      StoreAPI instance
    • getItemAPI

      public static ItemAPI<?,?,?> getItemAPI()
      Get ItemAPI for item formatting and lobby item registration.
      Returns:
      ItemAPI instance
    • getMessagesAPI

      public static MessageAPI<?> getMessagesAPI()
      Get MessageAPI for sending formatted messages.
      Returns:
      MessageAPI instance
    • getCoreConfig

      public static CoreConfigAPI getCoreConfig()
      Get CoreConfigAPI for accessing core plugin configurations. Provides access to settings.yml, messages.yml, sounds.yml, rewards.yml
      Returns:
      CoreConfigAPI instance
    • getModuleInfo

      public static ModuleInfo getModuleInfo(String moduleId)
      Get ModuleInfo for accessing module metadata from module.yml. This provides a clean way to access module information without having to duplicate it in code.
      Parameters:
      moduleId - Module ID (e.g., "race")
      Returns:
      ModuleInfo with metadata from module.yml
    • getSetupAPI

      public static GameSetupAPI getSetupAPI()
      Get GameSetupAPI for registering game setup commands. Allows modules to register their own /baa game handlers.
      Returns:
      GameSetupAPI instance
    • getStatsAPI

      public static StatsAPI getStatsAPI()
      Get stats API for registering and updating module stats.
      Returns:
      StatsAPI instance
    • getAchievementsAPI

      public static AchievementsAPI getAchievementsAPI()
      Get achievements API for registering and opening achievements.
      Returns:
      AchievementsAPI instance
    • getVisualEffectsAPI

      public static VisualEffectsAPI getVisualEffectsAPI()
      Get visual effects API for triggering store-based kill/death effects.
      Returns:
      VisualEffectsAPI instance
    • getPlayerUtil

      public static PlayerUtil<?> getPlayerUtil()
      Get PlayerUtil for player state checks outside a GameContext.
      Returns:
      PlayerUtil instance
    • getPersistentPlayerDataAPI

      public static PersistentPlayerDataAPI<?> getPersistentPlayerDataAPI()
      Get PersistentPlayerDataAPI for module-scoped persistent player data.
      Returns:
      PersistentPlayerDataAPI instance, or null if unavailable
      Since:
      3.4
    • getLanguageAPI

      public static LanguageAPI<?> getLanguageAPI()
      Get LanguageAPI for locale-aware module translations.
      Returns:
      LanguageAPI instance, or null if unavailable
      Since:
      3.4