Wiki Release: 2026.09.8 · UltimateRaids: 0.12.0 · Documentation branch: 1

Accessing the UltimateRaids API#

Declare UltimateRaids as a dependency or appropriate soft dependency, then use:

import me.ulrich.raids.api.UltimateRaidsAPI;
import me.ulrich.raids.api.UltimateRaidsProvider;

UltimateRaidsAPI api = UltimateRaidsProvider.get();

For optional integration:

UltimateRaidsProvider.getOptional().ifPresent(api -> {
    String pluginVersion = api.getPluginVersion();
    String apiVersion = api.getApiVersion();
});

Safety checks#

• Access the provider only after UltimateRaids is enabled.
• Do not hold/mutate internal RaidInstance or manager classes.
• Use public view/result classes returned by RaidAPI.
• Treat RaidStartResult, RaidQueueResult, RaidAccessResult and RaidVoteResult as the authoritative outcome of API actions.
• Unregister custom providers/processors when your extension/plugin disables if your lifecycle requires it.

The API version constant in the supplied source is 1.2.0.