Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents an oracle, which may have a Table or multiple child Oracles.

If you're looking for a way to crawl the oracle hierarchy in search of a specific ID, see IOracleBase.

Hierarchy

Index

Properties

$id: string
pattern

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

Aliases?: string[]

Alternate names for this item, including: names it had earlier in development that have since changed, alternate spellings/punctuation, common misspellings, and so on.

Category: string

The ID of the most recent OracleCategory ancestor of this item, if any.

Content?: IOracleContent

Metadata that describes an oracle's semantic or lexical content.

Description?: string

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

markdown

Data relevant to this item's display/rendering.

Member of?: string

The ID of the most recent Oracle ancestor of this item, if any.

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.

On a Match?: IOracleMatch

Describes the match behaviour of this oracle's table, if any, and provides a Text string describing it. Only appears on a handful of move oracles like Ask the Oracle and Advance a Threat.

Oracles?: IOracle[]

Oracle objects contained by this object.

This key appears only on 'branch' nodes of the oracle hierarchy 'tree': IOracleCategory, and IOracle (when it contains multiple closely-related tables).

Source: ISource

Information on this item's source.

Table?: IRow[]

Represents a single oracle table, where 'table' is defined as being something with a single roll range.

This key appears only on 'leaf' nodes of the oracle hierarchy 'tree' - in other words, many (but not all) IOracle objects.

Usage?: IOracleUsage

Information on the usage of this oracle: recommended number of rolls, etc.

Generated using TypeDoc