IEncounterBase | Dataforged API

Interface common to Encounter entries in Ironsworn and Ironsworn: Starforged, plus 'stubs' like IEncounterVariant.

see: IEncounter, IEncounterVariant

Hierarchy

ICyclopediaEntry
- IEncounterBase
  - IEncounter

Index

Properties

$id

$id: string

example: "Starforged/Encounters/Chiton"
pattern: ^(Starforged|Ironsworn)/Encounters/[A-z_-]+$

Description

Description: string

A user-facing markdown description of the item, consisting of one or more paragraphs.

markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

Optional Drives

Drives?: string[]

markdown

Optional Features

Features?: string[]

markdown

Name

Name: string

example: "Chiton"

Nature

Nature: EncounterNatureStarforged | EncounterNatureIronsworn

example: "Monster"

Optional Quest Starter

Quest Starter?: string

A markdown string describing the quest starter associated with this item.

markdown

Rank

Rank: ChallengeRank

Source

Source: ISource

Information on this item's source.

Optional Summary

Summary?: string

example: "Insectoid horde"
markdown

Optional Tactics

Tactics?: string[]

markdown

Optional Tags

Tags?: Vehicle[]

Optional Your Truth

Your Truth?: string

Ironsworn, p. 135: "Some NPCs include a question for you to answer. This is an opportunity to customize the NPC to your vision of the Ironlands. You can do this as you define your world or discover through play. Truths may represent an absolute fact, or merely something the people of your world believe."

Only present in Ironsworn encounters.

markdown