Options
All
  • Public
  • Public/Protected
  • All
Menu

An interface representing an Ironsworn: Starforged asset card.

Hierarchy

Index

Properties

$id: string
example

"Starforged/Assets/Path/Bounty_Hunter"

pattern

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

The asset's abilities.

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.

Asset Type: string

The ID of the asset's parent AssetType

example

"Starforged/Assets/Path"

Attachments?: IAssetAttachment

Details on what attachments (other assets) are accepted by this asset.

Condition Meter?: IConditionMeter

Information on this asset's condition meter, if any.

Data relevant to this item's display/rendering.

Inputs?: (IInputText | IInputSelect)[]

Data describing the Input controls that should be embedded in the card. Inputs embedded in specific asset abilities appear as keys of the corresponding ability object, instead.

Name: string

The asset's name - the title printed on the card.

example

"Bounty Hunter"

Requirement?: string

An optional markdown string representing the requirement text that appears at the top of some asset cards.

markdown
example

"If you wear your finely crafted set of personal armor..."

Source: ISource

Information on this item's source.

States?: IAssetState[]

Describes any states that the asset might have, such as "Broken". Some states may disable the asset entirely.

Tags?: string[]

Information on the asset's usage, such as whether its abilities are shared amongst the player characters.

Generated using TypeDoc