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
  • entity
  • strikemode
  • blankStrikeMode

Function blankStrikeMode

  • blankStrikeMode(
        type: StrikeModeType,
        name?: string,
    ):
        | sohl.entity.strikemode.MeleeStrikeMode.Data
        | sohl.entity.strikemode.MissileStrikeMode.Data
  • Build a blank, schema-valid strike mode of the requested type.

    Every field is seeded to the same default the corresponding DataModel schema field initializes to, so the returned object round-trips a Foundry update() into a weapon's system.strikeModes array or a combat technique's system.strikeMode without validation churn. The discriminated type fixes which subtype-specific fields are present.

    Parameters

    • type: StrikeModeType

      The strike-mode discriminator ("melee" or "missile").

    • name: string = "Strike"

      The display name for the new mode (defaults to "Strike").

    Returns
        | sohl.entity.strikemode.MeleeStrikeMode.Data
        | sohl.entity.strikemode.MissileStrikeMode.Data

    A fully-populated MeleeStrikeMode.Data or MissileStrikeMode.Data with default values.

    • Defined in src/entity/strikemode/blankStrikeMode.ts:65

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