Options
All
  • Public
  • Public/Protected
  • All
Menu

Basic interface for elements common to "cyclopedia" style pages, such as Regions (Ironsworn) and Encounters (Ironsworn and Starforged)

Hierarchy

Index

Properties

$id: string
pattern

^(Starforged|Ironsworn)/([A-z_-]+/)+$

Description: string

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

markdown
Display: IDisplay

Data relevant to this item's display/rendering.

Features?: string[]
Name: string

The item's internal name. Should be unique among its sibling elements, as this key is often used (along with the object's ancestors) to generate its $id.

If the item has Display.Title, that should be preferred for most user-facing labels.

Quest Starter?: string

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

markdown
Source: ISource

Information on this item's source.

Summary?: string

A user-facing markdown summary of the item. Summary is shorter than Description.

markdown
Tags?: string[]

Generated using TypeDoc