Skip to main content
Corvus Connection

IRpgBossApi

Interface
TheOmenDen.StreamPulse.Scripting.IRpgBossApiThe community boss fight from a script (ctx.Rpg.Boss, spec 073): start it, read the live state, or end it early, dispatching the same Mediator commands the !attack/!boss chat path and the boss nodes run (AC-15 parity), so a script is subject to the same gating and single-boss invariant. Failure-safe: a blocked gate, an already-active boss, an unknown slug, or any error yields the method's "no result" fallback (null, or simply completing for EndAsync), never a throw.

Members

3
  • EndAsync
    method
    ValueTask EndAsync(CancellationToken cancellationToken = default)
    Ends (despawns) the broadcaster's active community boss, forfeiting rewards. Completes regardless of outcome; never throws.
  • GetActiveAsync
    method
    ValueTask<RpgActiveBossInfo> GetActiveAsync(CancellationToken cancellationToken = default)
    The broadcaster's currently-active community boss, or null when none is fighting or on failure.
  • StartAsync
    method
    ValueTask<RpgActiveBossInfo> StartAsync(string slug, CancellationToken cancellationToken = default)
    Starts (spawns) the named community boss for the broadcaster, or null when one is already active, the slug is unknown, or on failure.