Wiki Release: 2026.09.8 · UltimateRaids: 0.12.0 · Documentation branch: 1
UltimateRaids API#
UltimateRaids 0.12.0 exposes public API contracts from me.ulrich.raids.api. The source declares public API version 1.2.0.
External plugins should obtain the API through UltimateRaidsProvider rather than casting internal managers.
UltimateRaidsAPI api = UltimateRaidsProvider.get();
RaidAPI raids = api.getRaidAPI();
Use getOptional()/isAvailable() when UltimateRaids is a soft dependency.
Public API areas#
RaidAPI— read-only raid/lobby/instance/stage views and supported lifecycle operations.RegistryAPI— register custom actions, rewards, objectives and requirements.IntegrationAPI— register custom item/entity/group/border/economy/schematic/visual providers.AddonAPI/ExtensionAPI— inspect loaded components.CommandAPI/GuiAPI/HooksAPI/LibAPI.- Bukkit events for raid, stage, wave, objective, boss, player lifecycle, reward and component lifecycle.
The API deliberately returns read-only view models rather than exposing mutable internal runtime managers.