mwg API
    Preparing search index...

    Class BattleHooks<C>

    A battle-scoped place for passive effects to run code, not just push a number - the seam mwg/actors' StatBlock modifiers and applyStatusEffect do not cover, since both are numeric-only. An ability reacting to "this creature switched in," a held item reacting to "this creature was hit," or a sleep/paralysis status answering "can this creature act this turn" are all the same shape: register a handler for a named event, and a game's battle loop calls it at the right moment.

    mwg names no events of its own beyond the strings a game passes - 'switchIn', 'hit', 'turnStart', whatever a game's battle loop actually fires. A "can this creature act" check is a plain convention on top of this, not special-cased: a handler mutates a shared context object ({ skip: false }, say) the same way any other side effect would, and the battle loop reads it back after emit returns.

    The registry itself is core.HookRegistry, shared with roguelike.CombatHooks. What is battle-specific is only the shape of what a handler receives: the creature the event is about, plus that optional shared context.

    import { BattleHooks } from '@datamoc/mw_games/battle';

    const hooks = new BattleHooks<{ name: string }>();
    const paralysis = {};

    hooks.on('turnStart', (creature, context) => {
      if ((context as { skip: boolean }).skip === undefined) return;
      (context as { skip: boolean }).skip = true; // this creature cannot act this turn
    }, paralysis);

    const context = { skip: false };
    hooks.emit('turnStart', { name: 'hero' }, context);

    Type Parameters

    • C

    Hierarchy (View Summary)

    Index
    constructor
    size
    clear emit off offSource on
    • get size(): number

      how many handlers are registered, across every event

      Returns number

    • runs every handler registered for event, in registration order

      Parameters

      • event: string
      • ...args: [creature: C, context?: unknown]

      Returns void

    • removes one specific handler; offSource is the usual way, this is for a one-off

      Parameters

      • handler: (...args: [creature: C, context?: unknown]) => void

      Returns void

    • removes every hook registered with this source - a fainted creature's ability leaving

      Parameters

      • source: unknown

      Returns void

    • Parameters

      • event: string
      • handler: (...args: [creature: C, context?: unknown]) => void
      • Optionalsource: unknown

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods