Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface representing a Starforged move.

Hierarchy

Index

Properties

$id: string
example

"Starforged/Moves/Adventure/Face_Danger"

pattern

^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3])/[A-z_-]+$

Asset?: string

The ID of the parent Asset of the move, if any.

Category: string

The ID of the move's category.

example

"Starforged/Moves/Adventure"

Data relevant to this item's display/rendering.

Name: string
example

"Face Danger"

Optional: boolean

Whether or not the source material presents this rules item as optional.

default

false

Oracles?: string[]

The IDs of any oracles directly referenced by the move, or vice versa.

Outcomes?: IMoveOutcomes

Outcome information for the move.

Progress Move?: boolean

Whether or not the move is a Progress Move. Progress moves roll two challenge dice against a progress score.

Source: ISource

Information on this item's source.

Suggestions?: ISuggestions

"Non-canonical" suggestions of related items. They might be convenient to present to the user, but in most implementations rolling them automatically is not recommended.

Tags?: string[]
Text: string

The item's rules text as a markdown string.

markdown
Trigger: IMoveTrigger

The move's trigger data.

Variant of?: string

The ID of the move that this move is a variant of, if any.

Generated using TypeDoc