Heroic Lands Heroic Lands
Home Thalorna Blog
Projects
Song of Heroic Lands HârnMaster 3 Modules API Documentation KnowledgeBase
License
  • Preparing search index...
  • The search index is not available
Song of Heroic Lands API - v0.8.2
  • Song of Heroic Lands API
  • sohl
  • document
  • item
  • logic
  • runStrikeModeTest

Function runStrikeModeTest

  • runStrikeModeTest(
        logic: StrikeModeCombatant,
        testKind: StrikeModeTestKind,
        context: sohl.entity.action.SohlActionContext<Partial<StrikeModeTestScope>>,
    ): Promise<sohl.entity.result.SuccessTestResult | undefined | false>
  • Resolve the strike mode (see resolveStrikeMode) and run the requested test against it, dispatching on testKind to the mode's attack / block / counterstrike modifier (via selectStrikeModeModifier). The context is passed straight through to the modifier's success test, so its speaker, title, and skipDialog flag propagate to the roll.

    Shared by sohl.document.item.logic.WeaponGearLogic and combat-technique sohl.document.item.logic.SkillLogic so weapons and techniques resolve and roll identically.

    Parameters

    • logic: StrikeModeCombatant

      The weapon or combat-technique logic that owns the strike modes.

    • testKind: StrikeModeTestKind

      Which test to run: "attack", "block", or "counterstrike".

    • context: sohl.entity.action.SohlActionContext<Partial<StrikeModeTestScope>>

      The action context; its scope.strikeModeId selects the mode.

    Returns Promise<sohl.entity.result.SuccessTestResult | undefined | false>

    The success-test result, undefined if the roll dialog was cancelled, or false when no strike mode/modifier could be resolved (e.g. a defense test requested on a missile mode).

    • Defined in src/document/item/logic/strikeModeTest.ts:169

Settings

Member Visibility
Song of Heroic Lands API - v0.8.2
  • Loading...

Generated using TypeDoc with typedoc-github-theme

© 2020–2026 Tom Rodriguez. Content under The World of Thalorna and Song of Heroic Lands is licensed under CC BY-SA 4.0; all other content is © Tom Rodriguez, all rights reserved. See License.

CC BY-SA 4.0 Discord