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

RaidAPI operations#

RaidAPI is the stable gameplay-facing contract.

Read definitions/runtime#

• getRaid(String raidId)
• getRaids()
• validateRaid(String raidId)
• getActiveRaids()
• getInstance(UUID)
• getInstance(Player)
• getCurrentStage(UUID)
• getCurrentStage(Player)
• getLobby(Player)
• getLobbies()
• getContribution(instanceId, playerId)

Start/stop#

• startRaid(String raidId)
• startRaid(String raidId, Location origin)
• startRaid(String raidId, Location origin, RaidStartMode mode)
• stopRaid(UUID instanceId, String reason)

RaidStartMode.NORMAL respects normal availability logic; FORCE is explicitly forceful.

Join/queue#

• canJoin(Player, UUID)
• joinRaid(Player, UUID)
• leaveRaid(Player)
• queueRaid(Player, String raidId, Location origin)
• queueRaidFromTrigger(Player, String raidId)

queueRaidFromTrigger is the generic hook intended for NPCs, signs and external integrations.

Lobby controls#

• toggleReady(Player)
• requestStartVote(Player)
• voteStart(Player, boolean)
• getVoteStatus(Player)

Progress/player state#

• getCompletions(UUID playerId, String raidId)
• getLives(Player)
• getParticipantState(Player)
• isInsideRaidArea(Player)
• isInRaid(Player)
• isInLobby(Player)