IOutcomeInfo | Dataforged API

Hierarchy

IHasId
IHasText
- IOutcomeInfo

Index

Properties

$id
Count as
In Control
Reroll
Text
With a Match

Properties

$id

$id: string

pattern: ^(Starforged|Ironsworn)/(Moves/[A-z_-]+/[A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[0-9]+|Moves/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/[A-z_-]+)/Outcomes/((Miss|Strong_Hit)(/With_a_Match)?|Weak_Hit)$

Optional Count as

Count as?: "Miss" | "Weak Hit" | "Strong Hit"

Count this roll as another roll outcome, e.g. "Count a weak hit as a miss"

Optional In Control

In Control?: boolean

Whether this outcome leaves the player character in control or not. If unspecified, assume that it's true on a Strong Hit, and false on a Weak Hit or Miss.

Optional Reroll

Reroll?: IMoveReroll

Information on rerolls offered by this move.

Text

Text: string

The item's rules text as a markdown string.

markdown

Optional With a Match

With a Match?: IOutcomeInfo

Defines a different outcome for this result with a match. Its text should replace the text of this object.