From cd607504d206c10f1f10faa03c01cdea7e9bf96f Mon Sep 17 00:00:00 2001 From: rsek Date: Sun, 10 Jul 2022 03:16:52 -0700 Subject: [PATCH] rebuild docs --- README.md | 8 +--- docs/enums/Json_Assets.AssetTypeName.html | 2 +- .../Json_Assets.InputSelectOptionType.html | 8 ++-- docs/enums/Json_Common.ChallengeRank.html | 2 +- docs/enums/Json_Common.ClockSegments.html | 2 +- docs/enums/Json_Common.ClockType.html | 2 +- docs/enums/Json_Common.Gamespace.html | 2 +- docs/enums/Json_Common.InputType.html | 8 ++-- docs/enums/Json_Common.MeterAlias.html | 2 +- docs/enums/Json_Common.MeterCondition.html | 8 ++-- docs/enums/Json_Common.MeterType.html | 2 +- .../Json_Common.PlayerConditionMeter.html | 2 +- .../Json_Common.ProgressTypeIronsworn.html | 2 +- .../Json_Common.ProgressTypeStarforged.html | 2 +- docs/enums/Json_Common.Replacement.html | 10 ++--- docs/enums/Json_Common.Stat.html | 2 +- ...n_Cyclopedia.EncounterNatureIronsworn.html | 2 +- ..._Cyclopedia.EncounterNatureStarforged.html | 2 +- docs/enums/Json_Cyclopedia.EncounterTags.html | 2 +- docs/enums/Json_GameObjects.Atmosphere.html | 2 +- docs/enums/Json_GameObjects.AttributeKey.html | 44 +++++++++---------- docs/enums/Json_GameObjects.Authority.html | 2 +- docs/enums/Json_GameObjects.Behavior.html | 2 +- .../enums/Json_GameObjects.CreatureScale.html | 2 +- docs/enums/Json_GameObjects.DerelictType.html | 2 +- docs/enums/Json_GameObjects.Disposition.html | 2 +- docs/enums/Json_GameObjects.Diversity.html | 2 +- docs/enums/Json_GameObjects.Dominion.html | 2 +- docs/enums/Json_GameObjects.Environment.html | 2 +- docs/enums/Json_GameObjects.FactionType.html | 2 +- docs/enums/Json_GameObjects.FringeGroup.html | 2 +- .../Json_GameObjects.GameObjectType.html | 2 +- docs/enums/Json_GameObjects.Guild.html | 2 +- docs/enums/Json_GameObjects.Influence.html | 2 +- docs/enums/Json_GameObjects.Leadership.html | 2 +- docs/enums/Json_GameObjects.Life.html | 2 +- docs/enums/Json_GameObjects.Location.html | 2 +- .../enums/Json_GameObjects.LocationTheme.html | 2 +- .../Json_GameObjects.PlanetaryClass.html | 2 +- docs/enums/Json_GameObjects.Population.html | 2 +- docs/enums/Json_GameObjects.Region.html | 2 +- docs/enums/Json_GameObjects.Role.html | 2 +- ..._GameObjects.SettlementInitialContact.html | 2 +- ...on_GameObjects.StarshipInitialContact.html | 2 +- docs/enums/Json_GameObjects.VaultZone.html | 2 +- docs/enums/Json_GameObjects.Zone.html | 2 +- docs/enums/Json_Meta.PartOfSpeechTag.html | 2 +- docs/enums/Json_Meta.SourceTitle.html | 2 +- docs/enums/Json_Meta.SourceUrl.html | 2 +- docs/enums/Json_Moves.MoveCategoryName.html | 2 +- docs/enums/Json_Moves.MoveOutcome.html | 2 +- docs/enums/Json_Moves.RerollType.html | 10 ++--- docs/enums/Json_Moves.RollMethod.html | 14 +++--- docs/enums/Json_Moves.RollType.html | 2 +- .../Json_SettingTruths.SettingTruthName.html | 2 +- docs/index.html | 5 +-- .../Json_Assets.IAlterMomentum.html | 4 +- .../Json_Assets.IAlterMomentumBurn.html | 4 +- .../Json_Assets.IAlterMomentumReset.html | 4 +- docs/interfaces/Json_Assets.IAlterMove.html | 22 +++++----- .../Json_Assets.IAlterMoveOutcomes.html | 4 +- .../Json_Assets.IAlterOutcomeInfo.html | 12 ++--- docs/interfaces/Json_Assets.IAsset.html | 26 +++++------ .../interfaces/Json_Assets.IAssetAbility.html | 18 ++++---- .../Json_Assets.IAssetAlterProperties.html | 24 +++++----- .../Json_Assets.IAssetAttachment.html | 4 +- docs/interfaces/Json_Assets.IAssetState.html | 10 ++--- docs/interfaces/Json_Assets.IAssetType.html | 16 +++---- docs/interfaces/Json_Assets.IAssetUsage.html | 2 +- docs/interfaces/Json_Assets.IInput.html | 6 +-- docs/interfaces/Json_Assets.IInputClock.html | 12 ++--- docs/interfaces/Json_Assets.IInputNumber.html | 8 ++-- docs/interfaces/Json_Assets.IInputSelect.html | 8 ++-- ...ssets.IInputSelectAttributeDefinition.html | 2 +- .../Json_Assets.IInputSelectOption.html | 6 +-- .../Json_Assets.IInputSelectOptionSetter.html | 4 +- ..._Assets.IInputSelectOptionSetterMeter.html | 4 +- ...Assets.IInputSelectOptionSetterNumber.html | 4 +- ...n_Assets.IInputSelectOptionSetterStat.html | 4 +- ...Assets.IInputSelectOptionSetterString.html | 4 +- docs/interfaces/Json_Assets.IInputText.html | 6 +-- .../Json_Common.IConditionMeter.html | 12 ++--- docs/interfaces/Json_Common.ICustomStat.html | 6 +-- .../Json_Common.ICustomStatOption.html | 6 +-- docs/interfaces/Json_Common.IMeterBase.html | 10 ++--- .../Json_Cyclopedia.ICyclopediaEntry.html | 16 +++---- .../Json_Cyclopedia.IEncounter.html | 18 ++++---- .../Json_Cyclopedia.IEncounterBase.html | 18 ++++---- .../Json_Cyclopedia.IEncounterIronsworn.html | 14 +++--- .../Json_Cyclopedia.IEncounterNatureInfo.html | 12 ++--- .../Json_Cyclopedia.IEncounterStarforged.html | 14 +++--- .../Json_Cyclopedia.IEncounterVariant.html | 10 ++--- .../Json_Cyclopedia.IIronswornRegion.html | 16 +++---- .../Json_GameObjects.IAttribute.html | 2 +- .../Json_GameObjects.IAttributeChoices.html | 2 +- .../Json_GameObjects.IAttributeMaster.html | 2 +- .../Json_GameObjects.IGameObject.html | 2 +- docs/interfaces/Json_Meta.IDisplay.html | 8 ++-- .../Json_Meta.IDisplayWithTitle.html | 8 ++-- docs/interfaces/Json_Meta.IHasAliases.html | 2 +- .../interfaces/Json_Meta.IHasDescription.html | 2 +- docs/interfaces/Json_Meta.IHasDisplay.html | 2 +- .../interfaces/Json_Meta.IHasGameObjects.html | 2 +- docs/interfaces/Json_Meta.IHasId.html | 2 +- docs/interfaces/Json_Meta.IHasName.html | 2 +- docs/interfaces/Json_Meta.IHasOptional.html | 2 +- .../Json_Meta.IHasOracleContent.html | 2 +- .../Json_Meta.IHasQuestStarter.html | 2 +- .../Json_Meta.IHasRequirements.html | 2 +- .../Json_Meta.IHasRollTemplate.html | 2 +- docs/interfaces/Json_Meta.IHasSource.html | 2 +- docs/interfaces/Json_Meta.IHasSubtable.html | 2 +- .../interfaces/Json_Meta.IHasSuggestions.html | 2 +- docs/interfaces/Json_Meta.IHasSummary.html | 2 +- docs/interfaces/Json_Meta.IHasTable.html | 2 +- docs/interfaces/Json_Meta.IHasTags.html | 2 +- docs/interfaces/Json_Meta.IHasText.html | 2 +- docs/interfaces/Json_Meta.IRequirements.html | 2 +- docs/interfaces/Json_Meta.ISource.html | 10 ++--- docs/interfaces/Json_Meta.ISuggestions.html | 10 ++--- docs/interfaces/Json_Moves.IMove.html | 28 ++++++------ docs/interfaces/Json_Moves.IMoveCategory.html | 12 ++--- docs/interfaces/Json_Moves.IMoveOutcomes.html | 4 +- docs/interfaces/Json_Moves.IMoveReroll.html | 4 +- docs/interfaces/Json_Moves.IMoveTrigger.html | 8 ++-- .../interfaces/Json_Moves.IMoveTriggerBy.html | 4 +- .../Json_Moves.IMoveTriggerOptionAction.html | 12 ++--- .../Json_Moves.IMoveTriggerOptionBase.html | 12 ++--- ...Json_Moves.IMoveTriggerOptionProgress.html | 12 ++--- docs/interfaces/Json_Moves.IOutcomeInfo.html | 12 ++--- .../Json_Oracles.IDisplayOracle.html | 14 +++--- .../Json_Oracles.IMultipleRolls.html | 6 +-- docs/interfaces/Json_Oracles.IOracle.html | 24 +++++----- docs/interfaces/Json_Oracles.IOracleBase.html | 26 +++++------ .../Json_Oracles.IOracleCategory.html | 24 +++++----- .../Json_Oracles.IOracleContent.html | 4 +- .../interfaces/Json_Oracles.IOracleUsage.html | 16 +++---- docs/interfaces/Json_Oracles.IRollColumn.html | 2 +- .../Json_Oracles.IRollTemplate.html | 6 +-- docs/interfaces/Json_Oracles.IRow.html | 28 ++++++------ .../Json_Oracles.ITableColumnBase.html | 2 +- .../Json_Oracles.ITableDisplayInfo.html | 2 +- docs/interfaces/Json_Oracles.ITextColumn.html | 6 +-- .../Json_SettingTruths.ISettingTruth.html | 14 +++--- ...son_SettingTruths.ISettingTruthOption.html | 32 +++++++------- ...Truths.ISettingTruthOptionSubtableRow.html | 28 ++++++------ docs/modules/Json_Assets.html | 2 +- docs/modules/Json_Common.html | 2 +- docs/modules/Json_GameObjects.html | 2 +- docs/modules/Json_Oracles.html | 2 +- tsconfig-cjs.json | 2 +- 151 files changed, 502 insertions(+), 511 deletions(-) diff --git a/README.md b/README.md index 8ee8fdc2f..3a25a135c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Dataforged v1.4.2

+

Dataforged v1.3.2

undefined undefined @@ -71,12 +71,6 @@ If you just want the data as-is, import the `starforged` object to use the pre-l import { starforged } from 'dataforged' ``` -If your project depends on something that doesn't support import assertions, you can instead use: - -```javascript -import { starforged } from 'dataforged/esm-no-assert' -``` - #### CommonJS ```javascript diff --git a/docs/enums/Json_Assets.AssetTypeName.html b/docs/enums/Json_Assets.AssetTypeName.html index 7892199bb..abaf0dbfe 100644 --- a/docs/enums/Json_Assets.AssetTypeName.html +++ b/docs/enums/Json_Assets.AssetTypeName.html @@ -1 +1 @@ -AssetTypeName | Dataforged API

Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration AssetTypeName

Index

Enumeration Members

CommandVehicle: "Command Vehicle"
Companion: "Companion"
Deed: "Deed"
Module: "Module"
Path: "Path"
SupportVehicle: "Support Vehicle"

Generated using TypeDoc

\ No newline at end of file +AssetTypeName | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration AssetTypeName

Index

Enumeration Members

CommandVehicle: "Command Vehicle"
Companion: "Companion"
Deed: "Deed"
Module: "Module"
Path: "Path"
SupportVehicle: "Support Vehicle"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Assets.InputSelectOptionType.html b/docs/enums/Json_Assets.InputSelectOptionType.html index 179f90617..e6666d87f 100644 --- a/docs/enums/Json_Assets.InputSelectOptionType.html +++ b/docs/enums/Json_Assets.InputSelectOptionType.html @@ -1,13 +1,13 @@ InputSelectOptionType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration InputSelectOptionType

The type of an attribute set by a Select Input.

-

Index

Enumeration Members

ConditionMeter: "Condition Meter"
+

Index

Enumeration Members

ConditionMeter: "Condition Meter"

A reference to one of the player character's condition meters: Health, Spirit, or Supply.

see

PlayerConditionMeter

-
Number: "Number"
+
Number: "Number"

A arbitrary pre-set number value.

-
Stat: "Stat"
+
Stat: "Stat"

A reference to one of the player character's stats: Edge, Heart, Iron, Shadow, or Wits.

see

Stat

-
String: "String"
+
String: "String"

An arbitrary pre-set string value.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.ChallengeRank.html b/docs/enums/Json_Common.ChallengeRank.html index f07f868bc..1de2711e4 100644 --- a/docs/enums/Json_Common.ChallengeRank.html +++ b/docs/enums/Json_Common.ChallengeRank.html @@ -1,4 +1,4 @@ ChallengeRank | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ChallengeRank

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Dangerous: 2
Epic: 5
Extreme: 4
Formidable: 3
Troublesome: 1

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.ClockSegments.html b/docs/enums/Json_Common.ClockSegments.html index 11bbb11cd..393d961b2 100644 --- a/docs/enums/Json_Common.ClockSegments.html +++ b/docs/enums/Json_Common.ClockSegments.html @@ -1 +1 @@ -ClockSegments | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ClockSegments

Generated using TypeDoc

\ No newline at end of file +ClockSegments | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ClockSegments

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.ClockType.html b/docs/enums/Json_Common.ClockType.html index cc75e6c7d..85b620977 100644 --- a/docs/enums/Json_Common.ClockType.html +++ b/docs/enums/Json_Common.ClockType.html @@ -1,3 +1,3 @@ ClockType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

See clocks (p. 234) for more information.

-

Index

Enumeration Members

Enumeration Members

Campaign: "Campaign"
Tension: "Tension"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Campaign: "Campaign"
Tension: "Tension"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.Gamespace.html b/docs/enums/Json_Common.Gamespace.html index 01a04e120..fefd24d92 100644 --- a/docs/enums/Json_Common.Gamespace.html +++ b/docs/enums/Json_Common.Gamespace.html @@ -1,3 +1,3 @@ Gamespace | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Some might say that "Gamespace" is a terrible pun. To them, I reply: you'll never take me alive.

-

Index

Enumeration Members

Enumeration Members

Ironsworn: "Ironsworn"
Starforged: "Starforged"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Ironsworn: "Ironsworn"
Starforged: "Starforged"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.InputType.html b/docs/enums/Json_Common.InputType.html index 6919047e1..15abdf834 100644 --- a/docs/enums/Json_Common.InputType.html +++ b/docs/enums/Json_Common.InputType.html @@ -1,5 +1,5 @@ -InputType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

Enumeration Members

Clock: "Clock"
Number: "Number"
Select: "Select"
Text: "Text"
see

IInputText

+InputType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.MeterAlias.html b/docs/enums/Json_Common.MeterAlias.html index d4e0fa915..542a32338 100644 --- a/docs/enums/Json_Common.MeterAlias.html +++ b/docs/enums/Json_Common.MeterAlias.html @@ -1,4 +1,4 @@ MeterAlias | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Names of non-player condition meters (for e.g. companions and vehicles) that are referenced by moves and other assets. If an asset condition meter can be used in this manner, the alias is included in its Aliases array.

-

Index

Enumeration Members

CommandVehicleIntegrity: "Command Vehicle Integrity"
CompanionHealth: "Companion Health"
IncidentalVehicleIntegrity: "Incidental Vehicle Integrity"
SupportVehicleIntegrity: "Support Vehicle Integrity"
VehicleIntegrity: "Vehicle Integrity"

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

CommandVehicleIntegrity: "Command Vehicle Integrity"
CompanionHealth: "Companion Health"
IncidentalVehicleIntegrity: "Incidental Vehicle Integrity"
SupportVehicleIntegrity: "Support Vehicle Integrity"
VehicleIntegrity: "Vehicle Integrity"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.MeterCondition.html b/docs/enums/Json_Common.MeterCondition.html index f2047ac37..2abb09577 100644 --- a/docs/enums/Json_Common.MeterCondition.html +++ b/docs/enums/Json_Common.MeterCondition.html @@ -1,14 +1,14 @@ MeterCondition | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration MeterCondition

Conditions (such as impacts) that can apply to asset cards with condition meters. These are typically presented as tick boxes on the asset card.

-

Index

Enumeration Members

Battered: "Battered"
+

Index

Enumeration Members

Battered: "Battered"

Battered may be marked when your vehicle is at 0 integrity and you fail to Withstand Damage. The vehicle is barely holding together.

page

51

-
Cursed: "Cursed"
+
Cursed: "Cursed"

Cursed may be marked when your command vehicle (STARSHIP asset) is at 0 integrity and you fail to Withstand Damage. This is a permanent impact. Your ship will never be quite right again.

page

51

-
OutOfAction: "Out of Action"
+
OutOfAction: "Out of Action"

When your companion’s health is at 0 and you score a miss, they are out of action. You cannot leverage their support until they gain at least +1 health. Envision what this means in the fiction of your scene.

page

204

-
Wrecked: "Wrecked"
+
Wrecked: "Wrecked"

Used by "Fleet Commander" asset

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.MeterType.html b/docs/enums/Json_Common.MeterType.html index da040ce62..3a38a627a 100644 --- a/docs/enums/Json_Common.MeterType.html +++ b/docs/enums/Json_Common.MeterType.html @@ -1,3 +1,3 @@ MeterType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumerates player character resource meters.

-

Index

Enumeration Members

Enumeration Members

Health: "Health"
Momentum: "Momentum"
Spirit: "Spirit"
Supply: "Supply"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Health: "Health"
Momentum: "Momentum"
Spirit: "Spirit"
Supply: "Supply"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.PlayerConditionMeter.html b/docs/enums/Json_Common.PlayerConditionMeter.html index 5f8cc5590..0b0e9e821 100644 --- a/docs/enums/Json_Common.PlayerConditionMeter.html +++ b/docs/enums/Json_Common.PlayerConditionMeter.html @@ -1,3 +1,3 @@ PlayerConditionMeter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration PlayerConditionMeter

Standard player character condition meters.

-

Index

Enumeration Members

Enumeration Members

Health: "Health"
Spirit: "Spirit"
Supply: "Supply"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Health: "Health"
Spirit: "Spirit"
Supply: "Supply"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.ProgressTypeIronsworn.html b/docs/enums/Json_Common.ProgressTypeIronsworn.html index a1bf5c2ec..8b53d2b8a 100644 --- a/docs/enums/Json_Common.ProgressTypeIronsworn.html +++ b/docs/enums/Json_Common.ProgressTypeIronsworn.html @@ -1 +1 @@ -ProgressTypeIronsworn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ProgressTypeIronsworn

Generated using TypeDoc

\ No newline at end of file +ProgressTypeIronsworn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ProgressTypeIronsworn

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.ProgressTypeStarforged.html b/docs/enums/Json_Common.ProgressTypeStarforged.html index c34bf6f41..06770befe 100644 --- a/docs/enums/Json_Common.ProgressTypeStarforged.html +++ b/docs/enums/Json_Common.ProgressTypeStarforged.html @@ -1 +1 @@ -ProgressTypeStarforged | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ProgressTypeStarforged

Index

Enumeration Members

Bonds: "Bonds Legacy"
Combat: "Combat"
Connection: "Connection"
Discoveries: "Discoveries Legacy"
Expedition: "Expedition"
Quests: "Quests Legacy"
SceneChallenge: "Scene Challenge"
Vow: "Vow"

Generated using TypeDoc

\ No newline at end of file +ProgressTypeStarforged | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration ProgressTypeStarforged

Index

Enumeration Members

Bonds: "Bonds Legacy"
Combat: "Combat"
Connection: "Connection"
Discoveries: "Discoveries Legacy"
Expedition: "Expedition"
Quests: "Quests Legacy"
SceneChallenge: "Scene Challenge"
Vow: "Vow"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.Replacement.html b/docs/enums/Json_Common.Replacement.html index f998e79af..cdd20ed8a 100644 --- a/docs/enums/Json_Common.Replacement.html +++ b/docs/enums/Json_Common.Replacement.html @@ -1,13 +1,13 @@ Replacement | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration Replacement

Standard replacement strings, used by constructors when processing the master YAML data.

-

Index

Enumeration Members

Asset: "${{@ASSET}}"
+

Index

Enumeration Members

Asset: "${{@ASSET}}"

Replace with the ID of the nearest ancestor asset.

-
AssetMeter: "${{@ASSET_METER}}"
+
AssetMeter: "${{@ASSET_METER}}"

Replace with the ID of the nearest ancestor asset's condition meter.

-
AssetSelectMeter: "${{@ASSET_SELECT_METER}}"
+
AssetSelectMeter: "${{@ASSET_SELECT_METER}}"

Replace with the ID of the nearest select option value of the ConditionMeter type.

-
AssetSelectStat: "${{@ASSET_SELECT_STAT}}"
+
AssetSelectStat: "${{@ASSET_SELECT_STAT}}"

Replace with the ID of the nearest select option value of the Stat type

-
CustomStat: "${{@CUSTOM_STAT}}"
+
CustomStat: "${{@CUSTOM_STAT}}"

Replace with the ID of the nearest ancestor move trigger's custom stat.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Common.Stat.html b/docs/enums/Json_Common.Stat.html index 16d3baf65..64566340f 100644 --- a/docs/enums/Json_Common.Stat.html +++ b/docs/enums/Json_Common.Stat.html @@ -1,3 +1,3 @@ Stat | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumerates player character stats.

-

Index

Enumeration Members

Enumeration Members

Edge: "Edge"
Heart: "Heart"
Iron: "Iron"
Shadow: "Shadow"
Wits: "Wits"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Edge: "Edge"
Heart: "Heart"
Iron: "Iron"
Shadow: "Shadow"
Wits: "Wits"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Cyclopedia.EncounterNatureIronsworn.html b/docs/enums/Json_Cyclopedia.EncounterNatureIronsworn.html index 67f09ecbf..eda76edf0 100644 --- a/docs/enums/Json_Cyclopedia.EncounterNatureIronsworn.html +++ b/docs/enums/Json_Cyclopedia.EncounterNatureIronsworn.html @@ -1 +1 @@ -EncounterNatureIronsworn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration EncounterNatureIronsworn

Generated using TypeDoc

\ No newline at end of file +EncounterNatureIronsworn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration EncounterNatureIronsworn

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Cyclopedia.EncounterNatureStarforged.html b/docs/enums/Json_Cyclopedia.EncounterNatureStarforged.html index 95ee5ec9d..074b68f45 100644 --- a/docs/enums/Json_Cyclopedia.EncounterNatureStarforged.html +++ b/docs/enums/Json_Cyclopedia.EncounterNatureStarforged.html @@ -1 +1 @@ -EncounterNatureStarforged | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration EncounterNatureStarforged

Generated using TypeDoc

\ No newline at end of file +EncounterNatureStarforged | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration EncounterNatureStarforged

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Cyclopedia.EncounterTags.html b/docs/enums/Json_Cyclopedia.EncounterTags.html index f90168da4..9f5a6dce1 100644 --- a/docs/enums/Json_Cyclopedia.EncounterTags.html +++ b/docs/enums/Json_Cyclopedia.EncounterTags.html @@ -1 +1 @@ -EncounterTags | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file +EncounterTags | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Atmosphere.html b/docs/enums/Json_GameObjects.Atmosphere.html index 34ada3a0b..8eb72ed83 100644 --- a/docs/enums/Json_GameObjects.Atmosphere.html +++ b/docs/enums/Json_GameObjects.Atmosphere.html @@ -1,3 +1,3 @@ Atmosphere | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Planets / * / Atmosphere

-
alpha

Index

Enumeration Members

Breathable: "Breathable"
Corrosive: "Corrosive"
Ideal: "Ideal"
Marginal: "Marginal"
NoneThin: "None / Thin"
Toxic: "Toxic"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Breathable: "Breathable"
Corrosive: "Corrosive"
Ideal: "Ideal"
Marginal: "Marginal"
NoneThin: "None / Thin"
Toxic: "Toxic"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.AttributeKey.html b/docs/enums/Json_GameObjects.AttributeKey.html index 1fca2332c..b4355a009 100644 --- a/docs/enums/Json_GameObjects.AttributeKey.html +++ b/docs/enums/Json_GameObjects.AttributeKey.html @@ -1,45 +1,45 @@ -AttributeKey | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

Atmosphere: "Atmosphere"
+AttributeKey | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

Atmosphere: "Atmosphere"
Authority: "Authority"
+
Authority: "Authority"
Behavior: "Encountered Behavior"
+
Behavior: "Encountered Behavior"
CreatureScale: "Creature Scale"
+
CreatureScale: "Creature Scale"
DerelictType: "Derelict Type"
+
DerelictType: "Derelict Type"
Disposition: "Disposition"
+
Disposition: "Disposition"
Dominion: "Dominion"
+
Dominion: "Dominion"
Environment: "Environment"
+
Environment: "Environment"
FactionType: "Faction Type"
+
FactionType: "Faction Type"
FringeGroup: "Fringe Group"
+
FringeGroup: "Fringe Group"
Guild: "Guild"
+
Guild: "Guild"
Influence: "Influence"
+
Influence: "Influence"
InitialContact: "Initial Contact"
+
InitialContact: "Initial Contact"
Leadership: "Leadership"
+
Leadership: "Leadership"
Life: "Life"
+
Life: "Life"

Life

-
Location: "Location"
+
Location: "Location"
LocationTheme: "Location Theme"
+
LocationTheme: "Location Theme"
PlanetaryClass: "Planetary Class"
+
PlanetaryClass: "Planetary Class"
Population: "Population"
+
Population: "Population"
Region: "Region"
+
Region: "Region"
Role: "Role"
+
Role: "Role"

Role

-
Zone: "Zone"
+
Zone: "Zone"

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Authority.html b/docs/enums/Json_GameObjects.Authority.html index c63dba4c6..43809b140 100644 --- a/docs/enums/Json_GameObjects.Authority.html +++ b/docs/enums/Json_GameObjects.Authority.html @@ -1,3 +1,3 @@ Authority | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Settlements / Authority

-
alpha

Index

Enumeration Members

Corrupt: "Corrupt"
Fair: "Fair"
Ineffectual: "Ineffectual"
NoneLawless: "None / lawless"
Oppressive: "Oppressive"
Tolerant: "Tolerant"
Unyielding: "Unyielding"

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Corrupt: "Corrupt"
Fair: "Fair"
Ineffectual: "Ineffectual"
NoneLawless: "None / lawless"
Oppressive: "Oppressive"
Tolerant: "Tolerant"
Unyielding: "Unyielding"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Behavior.html b/docs/enums/Json_GameObjects.Behavior.html index 4716475a5..14c1649f5 100644 --- a/docs/enums/Json_GameObjects.Behavior.html +++ b/docs/enums/Json_GameObjects.Behavior.html @@ -1,3 +1,3 @@ Behavior | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Creatures / Encountered Behavior

-
alpha

Index

Enumeration Members

Ambusher: "Ambusher"
ApexPredator: "Apex predator"
Builder: "Builder"
Camouflager: "Camouflager"
Forager: "Forager"
Grazer: "Grazer"
Herder: "Herder"
Hibernator: "Hibernator"
Hoarder: "Hoarder"
Hunter: "Hunter"
Lurer: "Lurer"
Migratory: "Migratory"
Mimic: "Mimic"
Nester: "Nester"
PackHunter: "Pack hunter"
Prey: "Prey"
Protector: "Protector"
Scavenger: "Scavenger"
Tracker: "Tracker"
Trapper: "Trapper"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Ambusher: "Ambusher"
ApexPredator: "Apex predator"
Builder: "Builder"
Camouflager: "Camouflager"
Forager: "Forager"
Grazer: "Grazer"
Herder: "Herder"
Hibernator: "Hibernator"
Hoarder: "Hoarder"
Hunter: "Hunter"
Lurer: "Lurer"
Migratory: "Migratory"
Mimic: "Mimic"
Nester: "Nester"
PackHunter: "Pack hunter"
Prey: "Prey"
Protector: "Protector"
Scavenger: "Scavenger"
Tracker: "Tracker"
Trapper: "Trapper"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.CreatureScale.html b/docs/enums/Json_GameObjects.CreatureScale.html index 681190882..130992d7b 100644 --- a/docs/enums/Json_GameObjects.CreatureScale.html +++ b/docs/enums/Json_GameObjects.CreatureScale.html @@ -1,3 +1,3 @@ CreatureScale | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Creatures / Scale/**

-
alpha

Index

Enumeration Members

Colossal: "Colossal"
Huge: "Huge"
Large: "Large"
Medium: "Medium"
Minuscule: "Minuscule"
Small: "Small"
Tiny: "Tiny"
Titanic: "Titanic"
Vast: "Vast"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Colossal: "Colossal"
Huge: "Huge"
Large: "Large"
Medium: "Medium"
Minuscule: "Minuscule"
Small: "Small"
Tiny: "Tiny"
Titanic: "Titanic"
Vast: "Vast"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.DerelictType.html b/docs/enums/Json_GameObjects.DerelictType.html index 567e98c05..01c52cde2 100644 --- a/docs/enums/Json_GameObjects.DerelictType.html +++ b/docs/enums/Json_GameObjects.DerelictType.html @@ -1,3 +1,3 @@ DerelictType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by oracle: Oracles / Derelicts / Type

-
alpha

Index

Enumeration Members

Enumeration Members

Settlement: "Settlement"
Starship: "Starship"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Settlement: "Settlement"
Starship: "Starship"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Disposition.html b/docs/enums/Json_GameObjects.Disposition.html index d4d48fc3b..050ec1450 100644 --- a/docs/enums/Json_GameObjects.Disposition.html +++ b/docs/enums/Json_GameObjects.Disposition.html @@ -1,3 +1,3 @@ Disposition | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Characters / Disposition

-
alpha

Index

Enumeration Members

Cooperative: "Cooperative"
Curious: "Curious"
Demanding: "Demanding"
Desperate: "Desperate"
Friendly: "Friendly"
Helpful: "Helpful"
Hostile: "Hostile"
Indifferent: "Indifferent"
Suspicious: "Suspicious"
Threatening: "Threatening"
Unfriendly: "Unfriendly"
Wanting: "Wanting"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Cooperative: "Cooperative"
Curious: "Curious"
Demanding: "Demanding"
Desperate: "Desperate"
Friendly: "Friendly"
Helpful: "Helpful"
Hostile: "Hostile"
Indifferent: "Indifferent"
Suspicious: "Suspicious"
Threatening: "Threatening"
Unfriendly: "Unfriendly"
Wanting: "Wanting"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Diversity.html b/docs/enums/Json_GameObjects.Diversity.html index d223abafc..7b8a1d563 100644 --- a/docs/enums/Json_GameObjects.Diversity.html +++ b/docs/enums/Json_GameObjects.Diversity.html @@ -1,3 +1,3 @@ Diversity | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Planets / Vital / Diversity

-
alpha

Index

Enumeration Members

Complex: 4
Diverse: 3
GardenWorld: 5
Simple: 2

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Complex: 4
Diverse: 3
GardenWorld: 5
Simple: 2

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Dominion.html b/docs/enums/Json_GameObjects.Dominion.html index 911e33c1b..9a15b02d0 100644 --- a/docs/enums/Json_GameObjects.Dominion.html +++ b/docs/enums/Json_GameObjects.Dominion.html @@ -1,3 +1,3 @@ Dominion | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Factions / Dominion

-
alpha

Index

Enumeration Members

Agriculture: "Agriculture"
Artistry: "Artistry"
Commerce: "Commerce"
Conquest: "Conquest"
Construction: "Construction"
Diplomacy: "Diplomacy"
Education: "Education"
Environmentalism: "Environmentalism"
Exploration: "Exploration"
Faith: "Faith"
History: "History"
Honor: "Honor"
Industry: "Industry"
Isolationism: "Isolationism"
Law: "Law"
Mysticism: "Mysticism"
Pacifism: "Pacifism"
Prophecy: "Prophecy"
Science: "Science"
Secrecy: "Secrecy"
Technology: "Technology"
Treachery: "Treachery"
Warfare: "Warfare"
Wealth: "Wealth"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Agriculture: "Agriculture"
Artistry: "Artistry"
Commerce: "Commerce"
Conquest: "Conquest"
Construction: "Construction"
Diplomacy: "Diplomacy"
Education: "Education"
Environmentalism: "Environmentalism"
Exploration: "Exploration"
Faith: "Faith"
History: "History"
Honor: "Honor"
Industry: "Industry"
Isolationism: "Isolationism"
Law: "Law"
Mysticism: "Mysticism"
Pacifism: "Pacifism"
Prophecy: "Prophecy"
Science: "Science"
Secrecy: "Secrecy"
Technology: "Technology"
Treachery: "Treachery"
Warfare: "Warfare"
Wealth: "Wealth"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Environment.html b/docs/enums/Json_GameObjects.Environment.html index 59ea22ce1..df022c202 100644 --- a/docs/enums/Json_GameObjects.Environment.html +++ b/docs/enums/Json_GameObjects.Environment.html @@ -1,3 +1,3 @@ Environment | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Creatures / Environment

-
alpha

Index

Enumeration Members

Enumeration Members

Air: "Air"
Interior: "Interior"
Land: "Land"
Liquid: "Liquid"
Space: "Space"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Air: "Air"
Interior: "Interior"
Land: "Land"
Liquid: "Liquid"
Space: "Space"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.FactionType.html b/docs/enums/Json_GameObjects.FactionType.html index 500c05e4b..5eeb1596d 100644 --- a/docs/enums/Json_GameObjects.FactionType.html +++ b/docs/enums/Json_GameObjects.FactionType.html @@ -1,3 +1,3 @@ FactionType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Factions / Type

-
alpha

Index

Enumeration Members

Enumeration Members

Dominion: "Dominion"
FringeGroup: "Fringe Group"
Guild: "Guild"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Dominion: "Dominion"
FringeGroup: "Fringe Group"
Guild: "Guild"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.FringeGroup.html b/docs/enums/Json_GameObjects.FringeGroup.html index 3e1f76842..3c7fe37be 100644 --- a/docs/enums/Json_GameObjects.FringeGroup.html +++ b/docs/enums/Json_GameObjects.FringeGroup.html @@ -1,3 +1,3 @@ FringeGroup | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Factions / Fringe Group

-
alpha

Index

Enumeration Members

Cultists: "Cultists"
Exiles: "Exiles"
Gangsters: "Gangsters"
Hackers: "Hackers"
MonsterHunters: "Monster hunters"
Pirates: "Pirates"
Raiders: "Raiders"
Rebels: "Rebels"
RogueAI: "Rogue AI"
Scavengers: "Scavengers"
Smugglers: "Smugglers"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Cultists: "Cultists"
Exiles: "Exiles"
Gangsters: "Gangsters"
Hackers: "Hackers"
MonsterHunters: "Monster hunters"
Pirates: "Pirates"
Raiders: "Raiders"
Rebels: "Rebels"
RogueAI: "Rogue AI"
Scavengers: "Scavengers"
Smugglers: "Smugglers"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.GameObjectType.html b/docs/enums/Json_GameObjects.GameObjectType.html index a7274961e..a1968d0bd 100644 --- a/docs/enums/Json_GameObjects.GameObjectType.html +++ b/docs/enums/Json_GameObjects.GameObjectType.html @@ -1 +1 @@ -GameObjectType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

Character: "Character"
Creature: "Creature"
Derelict: "Derelict"
DerelictZone: "Derelict Zone"
Faction: "Faction"
Planet: "Planet"
PrecursorVault: "Precursor Vault"
Settlement: "Settlement"
Starship: "Starship"

Generated using TypeDoc

\ No newline at end of file +GameObjectType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

Character: "Character"
Creature: "Creature"
Derelict: "Derelict"
DerelictZone: "Derelict Zone"
Faction: "Faction"
Planet: "Planet"
PrecursorVault: "Precursor Vault"
Settlement: "Settlement"
Starship: "Starship"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Guild.html b/docs/enums/Json_GameObjects.Guild.html index 92f1bfafb..223dfffc8 100644 --- a/docs/enums/Json_GameObjects.Guild.html +++ b/docs/enums/Json_GameObjects.Guild.html @@ -1,3 +1,3 @@ Guild | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Factions / Guild

-
alpha

Index

Enumeration Members

Assassins: "Assassins"
BountyHunters: "Bounty Hunters"
Couriers: "Couriers"
Courtesans: "Courtesans"
Engineers: "Engineers"
Healers: "Healers"
Industrialists: "Industrialists"
Mercenaries: "Mercenaries"
Merchants: "Merchants"
Mystics: "Mystics"
Navigators: "Navigators"
Peacekeepers: "Peacekeepers"
Researchers: "Researchers"
Spies: "Spies"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Assassins: "Assassins"
BountyHunters: "Bounty Hunters"
Couriers: "Couriers"
Courtesans: "Courtesans"
Engineers: "Engineers"
Healers: "Healers"
Industrialists: "Industrialists"
Mercenaries: "Mercenaries"
Merchants: "Merchants"
Mystics: "Mystics"
Navigators: "Navigators"
Peacekeepers: "Peacekeepers"
Researchers: "Researchers"
Spies: "Spies"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Influence.html b/docs/enums/Json_GameObjects.Influence.html index 12660bda4..76ef60466 100644 --- a/docs/enums/Json_GameObjects.Influence.html +++ b/docs/enums/Json_GameObjects.Influence.html @@ -1,3 +1,3 @@ Influence | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Factions / Influence

-
alpha

Index

Enumeration Members

Dominant: "Dominant"
Established: "Established"
Forsaken: "Forsaken"
Inescapable: "Inescapable"
Isolated: "Isolated"
Localized: "Localized"
Notable: "Notable"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Dominant: "Dominant"
Established: "Established"
Forsaken: "Forsaken"
Inescapable: "Inescapable"
Isolated: "Isolated"
Localized: "Localized"
Notable: "Notable"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Leadership.html b/docs/enums/Json_GameObjects.Leadership.html index b4338198c..266b9be95 100644 --- a/docs/enums/Json_GameObjects.Leadership.html +++ b/docs/enums/Json_GameObjects.Leadership.html @@ -1,3 +1,3 @@ Leadership | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Factions / Leadership

-
alpha

Index

Enumeration Members

Anarchist: "Anarchist"
AuthoritarianDictatorship: "Authoritarian dictatorship"
ClanChiefsOrElders: "Clan chiefs or elders"
DisputedLeadership: "Disputed leadership"
DynasticLineage: "Dynastic lineage"
ElectedRepresentatives: "Elected representatives"
FatedOrProphesiedLeader: "Fated or prophesied leader"
MachineIntelligence: "Machine intelligence"
OligarchicalElite: "Oligarchical elite"
VariedDecentralized: "Varied / decentralized"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Anarchist: "Anarchist"
AuthoritarianDictatorship: "Authoritarian dictatorship"
ClanChiefsOrElders: "Clan chiefs or elders"
DisputedLeadership: "Disputed leadership"
DynasticLineage: "Dynastic lineage"
ElectedRepresentatives: "Elected representatives"
FatedOrProphesiedLeader: "Fated or prophesied leader"
MachineIntelligence: "Machine intelligence"
OligarchicalElite: "Oligarchical elite"
VariedDecentralized: "Varied / decentralized"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Life.html b/docs/enums/Json_GameObjects.Life.html index d1b3a6d99..892e5a716 100644 --- a/docs/enums/Json_GameObjects.Life.html +++ b/docs/enums/Json_GameObjects.Life.html @@ -1,3 +1,3 @@ Life | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Planets / * / Life

-
alpha

Index

Enumeration Members

Bountiful: "Bountiful"
Diverse: "Diverse"
Extinct: "Extinct"
None: "None"
Overrun: "Overrun"
Scarce: "Scarce"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Bountiful: "Bountiful"
Diverse: "Diverse"
Extinct: "Extinct"
None: "None"
Overrun: "Overrun"
Scarce: "Scarce"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Location.html b/docs/enums/Json_GameObjects.Location.html index a9a6980a8..f37dee4eb 100644 --- a/docs/enums/Json_GameObjects.Location.html +++ b/docs/enums/Json_GameObjects.Location.html @@ -1,3 +1,3 @@ Location | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / ** / Location

-
alpha

Index

Enumeration Members

Enumeration Members

DeepSpace: "Deep Space"
Orbital: "Orbital"
Planetside: "Planetside"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

DeepSpace: "Deep Space"
Orbital: "Orbital"
Planetside: "Planetside"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.LocationTheme.html b/docs/enums/Json_GameObjects.LocationTheme.html index 21b8cad62..50b1e94de 100644 --- a/docs/enums/Json_GameObjects.LocationTheme.html +++ b/docs/enums/Json_GameObjects.LocationTheme.html @@ -1,3 +1,3 @@ LocationTheme | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Location Themes / Theme Type

-

Index

Enumeration Members

Chaotic: "Chaotic"
Fortified: "Fortified"
Haunted: "Haunted"
Infested: "Infested"
Inhabited: "Inhabited"
Mechanical: "Mechanical"
Ruined: "Ruined"
Sacred: "Sacred"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Chaotic: "Chaotic"
Fortified: "Fortified"
Haunted: "Haunted"
Infested: "Infested"
Inhabited: "Inhabited"
Mechanical: "Mechanical"
Ruined: "Ruined"
Sacred: "Sacred"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.PlanetaryClass.html b/docs/enums/Json_GameObjects.PlanetaryClass.html index 815d86c9d..5c48d1ff9 100644 --- a/docs/enums/Json_GameObjects.PlanetaryClass.html +++ b/docs/enums/Json_GameObjects.PlanetaryClass.html @@ -1,3 +1,3 @@ PlanetaryClass | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Desert: "Desert"
Furnace: "Furnace"
Grave: "Grave"
Ice: "Ice"
Jovian: "Jovian"
Jungle: "Jungle"
Ocean: "Ocean"
Rocky: "Rocky"
Shattered: "Shattered"
Tainted: "Tainted"
Vital: "Vital"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Population.html b/docs/enums/Json_GameObjects.Population.html index 1170010ec..d55625bd2 100644 --- a/docs/enums/Json_GameObjects.Population.html +++ b/docs/enums/Json_GameObjects.Population.html @@ -1,3 +1,3 @@ Population | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Settlements / Population

-
alpha

Index

Enumeration Members

Dozens: "Dozens"
Few: "Few"
Hundreds: "Hundreds"
TensOfThousands: "Tens of thousands"
Thousands: "Thousands"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Dozens: "Dozens"
Few: "Few"
Hundreds: "Hundreds"
TensOfThousands: "Tens of thousands"
Thousands: "Thousands"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Region.html b/docs/enums/Json_GameObjects.Region.html index f12120234..41980a007 100644 --- a/docs/enums/Json_GameObjects.Region.html +++ b/docs/enums/Json_GameObjects.Region.html @@ -1 +1 @@ -Region | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file +Region | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Role.html b/docs/enums/Json_GameObjects.Role.html index 9d6e98752..8ed103f68 100644 --- a/docs/enums/Json_GameObjects.Role.html +++ b/docs/enums/Json_GameObjects.Role.html @@ -1,3 +1,3 @@ Role | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Set by Oracles / Character / Role

-
alpha

Index

Enumeration Members

AI: "AI"
Agent: "Agent"
Artisan: "Artisan"
Assassin: "Assassin"
BountyHunter: "Hunter"
Courier: "Courier"
Crew: "Crew"
Criminal: "Criminal"
Cultist: "Cultist"
Diplomat: "Diplomat"
Engineer: "Engineer"
Entertainer: "Entertainer"
Explorer: "Explorer"
Farmer: "Farmer"
Fugitive: "Fugitive"
Guard: "Guard"
Guide: "Guide"
Healer: "Healer"
Historian: "Historian"
Hunter: "Hunter"
Investigator: "Investigator"
Laborer: "Laborer"
Lawkeeper: "Lawkeeper"
Leader: "Leader"
Mercenary: "Mercenary"
Merchant: "Merchant"
Miner: "Miner"
Mystic: "Mystic"
Navigator: "Navigator"
Outcast: "Outcast"
Pilgrim: "Pilgrim"
Pilot: "Pilot"
Pirate: "Pirate"
Preacher: "Preacher"
Prophet: "Prophet"
Raider: "Raider"
Researcher: "Researcher"
Scavenger: "Scavenger"
Scholar: "Scholar"
Scout: "Scout"
Shipwright: "Shipwright"
Smuggler: "Smuggler"
Soldier: "Soldier"
Spacer: "Spacer"
Technician: "Technician"
Thief: "Thief"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

AI: "AI"
Agent: "Agent"
Artisan: "Artisan"
Assassin: "Assassin"
BountyHunter: "Hunter"
Courier: "Courier"
Crew: "Crew"
Criminal: "Criminal"
Cultist: "Cultist"
Diplomat: "Diplomat"
Engineer: "Engineer"
Entertainer: "Entertainer"
Explorer: "Explorer"
Farmer: "Farmer"
Fugitive: "Fugitive"
Guard: "Guard"
Guide: "Guide"
Healer: "Healer"
Historian: "Historian"
Hunter: "Hunter"
Investigator: "Investigator"
Laborer: "Laborer"
Lawkeeper: "Lawkeeper"
Leader: "Leader"
Mercenary: "Mercenary"
Merchant: "Merchant"
Miner: "Miner"
Mystic: "Mystic"
Navigator: "Navigator"
Outcast: "Outcast"
Pilgrim: "Pilgrim"
Pilot: "Pilot"
Pirate: "Pirate"
Preacher: "Preacher"
Prophet: "Prophet"
Raider: "Raider"
Researcher: "Researcher"
Scavenger: "Scavenger"
Scholar: "Scholar"
Scout: "Scout"
Shipwright: "Shipwright"
Smuggler: "Smuggler"
Soldier: "Soldier"
Spacer: "Spacer"
Technician: "Technician"
Thief: "Thief"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.SettlementInitialContact.html b/docs/enums/Json_GameObjects.SettlementInitialContact.html index 34b219b4c..61d7830f9 100644 --- a/docs/enums/Json_GameObjects.SettlementInitialContact.html +++ b/docs/enums/Json_GameObjects.SettlementInitialContact.html @@ -1 +1 @@ -SettlementInitialContact | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration SettlementInitialContact

Generated using TypeDoc

\ No newline at end of file +SettlementInitialContact | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration SettlementInitialContact

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.StarshipInitialContact.html b/docs/enums/Json_GameObjects.StarshipInitialContact.html index 91b8a103d..92e3fa48b 100644 --- a/docs/enums/Json_GameObjects.StarshipInitialContact.html +++ b/docs/enums/Json_GameObjects.StarshipInitialContact.html @@ -1 +1 @@ -StarshipInitialContact | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration StarshipInitialContact

Generated using TypeDoc

\ No newline at end of file +StarshipInitialContact | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration StarshipInitialContact

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.VaultZone.html b/docs/enums/Json_GameObjects.VaultZone.html index 1596fdb6f..4fcc974af 100644 --- a/docs/enums/Json_GameObjects.VaultZone.html +++ b/docs/enums/Json_GameObjects.VaultZone.html @@ -1 +1 @@ -VaultZone | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file +VaultZone | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_GameObjects.Zone.html b/docs/enums/Json_GameObjects.Zone.html index 0fa9c3687..8bdbd1039 100644 --- a/docs/enums/Json_GameObjects.Zone.html +++ b/docs/enums/Json_GameObjects.Zone.html @@ -1 +1 @@ -Zone | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

Access: "Access"
Community: "Community"
Engineering: "Engineering"
Living: "Living"
Medical: "Medical"
Operations: "Operations"
Production: "Production"
Research: "Research"

Generated using TypeDoc

\ No newline at end of file +Zone | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

Access: "Access"
Community: "Community"
Engineering: "Engineering"
Living: "Living"
Medical: "Medical"
Operations: "Operations"
Production: "Production"
Research: "Research"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Meta.PartOfSpeechTag.html b/docs/enums/Json_Meta.PartOfSpeechTag.html index 24ad15c17..8aa302772 100644 --- a/docs/enums/Json_Meta.PartOfSpeechTag.html +++ b/docs/enums/Json_Meta.PartOfSpeechTag.html @@ -1 +1 @@ -PartOfSpeechTag | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration PartOfSpeechTag

Index

Enumeration Members

Adjective: "adjective"
CommonNoun: "common noun"
CompoundNoun: "compound noun"
Fragment: "fragment"
Name: "name"
Noun: "noun"
Plural: "plural"
PossessiveCase: "possessive case"
ProperNoun: "proper noun"
ProperNounFragment: "proper noun fragment"
Sentences: "sentences"
Verb: "verb"

Generated using TypeDoc

\ No newline at end of file +PartOfSpeechTag | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration PartOfSpeechTag

Index

Enumeration Members

Adjective: "adjective"
CommonNoun: "common noun"
CompoundNoun: "compound noun"
Fragment: "fragment"
Name: "name"
Noun: "noun"
Plural: "plural"
PossessiveCase: "possessive case"
ProperNoun: "proper noun"
ProperNounFragment: "proper noun fragment"
Sentences: "sentences"
Verb: "verb"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Meta.SourceTitle.html b/docs/enums/Json_Meta.SourceTitle.html index bac357bdd..d52d2f0dc 100644 --- a/docs/enums/Json_Meta.SourceTitle.html +++ b/docs/enums/Json_Meta.SourceTitle.html @@ -1,3 +1,3 @@ SourceTitle | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration SourceTitle

Enumerates valid sourcebook titles.

-

Index

Enumeration Members

Custom: "Custom"
Ironsworn: "Ironsworn Rulebook"
IronswornAssets: "Ironsworn Assets"
IronswornBonusAssets: "Ironsworn Bonus Assets (July 2020)"
IronswornDelve: "Ironsworn: Delve"
Starforged: "Ironsworn: Starforged Rulebook"
StarforgedAssets: "Ironsworn: Starforged Assets"
SunderedIslesPreview: "Sundered Isles Preview"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Custom: "Custom"
Ironsworn: "Ironsworn Rulebook"
IronswornAssets: "Ironsworn Assets"
IronswornBonusAssets: "Ironsworn Bonus Assets (July 2020)"
IronswornDelve: "Ironsworn: Delve"
Starforged: "Ironsworn: Starforged Rulebook"
StarforgedAssets: "Ironsworn: Starforged Assets"
SunderedIslesPreview: "Sundered Isles Preview"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Meta.SourceUrl.html b/docs/enums/Json_Meta.SourceUrl.html index 821657179..9b48631c5 100644 --- a/docs/enums/Json_Meta.SourceUrl.html +++ b/docs/enums/Json_Meta.SourceUrl.html @@ -1,3 +1,3 @@ SourceUrl | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration SourceUrl

Enumerates valid source URLs.

-

Index

Enumeration Members

Ironsworn: "https://shawn-tomkin.itch.io/ironsworn"
IronswornAssets: "https://shawn-tomkin.itch.io/ironsworn"
IronswornBonusAssets: "https://drive.google.com/file/d/1bWyWxJzV_SVtyE_SeEGS4TMJ1ZBHfrdv/view"
IronswornDelve: "https://shawn-tomkin.itch.io/ironsworn-delve"
Starforged: "https://getstarforged.com"
StarforgedAssets: "https://getstarforged.com"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Ironsworn: "https://shawn-tomkin.itch.io/ironsworn"
IronswornAssets: "https://shawn-tomkin.itch.io/ironsworn"
IronswornBonusAssets: "https://drive.google.com/file/d/1bWyWxJzV_SVtyE_SeEGS4TMJ1ZBHfrdv/view"
IronswornDelve: "https://shawn-tomkin.itch.io/ironsworn-delve"
Starforged: "https://getstarforged.com"
StarforgedAssets: "https://getstarforged.com"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Moves.MoveCategoryName.html b/docs/enums/Json_Moves.MoveCategoryName.html index 8d924f516..32358d0a5 100644 --- a/docs/enums/Json_Moves.MoveCategoryName.html +++ b/docs/enums/Json_Moves.MoveCategoryName.html @@ -1,3 +1,3 @@ MoveCategoryName | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration MoveCategoryName

"Assets" is also valid, technically, but it's only used in IDs, so it's omitted here.

-

Index

Enumeration Members

Adventure: "Adventure"
Combat: "Combat"
Connection: "Connection"
Exploration: "Exploration"
Fate: "Fate"
Legacy: "Legacy"
Quest: "Quest"
Recover: "Recover"
Session: "Session"
Suffer: "Suffer"
Threshold: "Threshold"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Adventure: "Adventure"
Combat: "Combat"
Connection: "Connection"
Exploration: "Exploration"
Fate: "Fate"
Legacy: "Legacy"
Quest: "Quest"
Recover: "Recover"
Session: "Session"
Suffer: "Suffer"
Threshold: "Threshold"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Moves.MoveOutcome.html b/docs/enums/Json_Moves.MoveOutcome.html index 61771f45b..8b994670d 100644 --- a/docs/enums/Json_Moves.MoveOutcome.html +++ b/docs/enums/Json_Moves.MoveOutcome.html @@ -1 +1 @@ -MoveOutcome | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration MoveOutcome

Generated using TypeDoc

\ No newline at end of file +MoveOutcome | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration MoveOutcome

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Moves.RerollType.html b/docs/enums/Json_Moves.RerollType.html index 927b6348d..c4244db77 100644 --- a/docs/enums/Json_Moves.RerollType.html +++ b/docs/enums/Json_Moves.RerollType.html @@ -1,13 +1,13 @@ RerollType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration RerollType

Enumerates which dice are to be rerolled.

-

Index

Enumeration Members

ActionDie: "Action die"
+

Index

Enumeration Members

ActionDie: "Action die"

The action die is rerolled.

-
All: "All"
+
All: "All"

Reroll all dice

-
Any: "Any"
+
Any: "Any"

The player can pick and choose which dice to reroll.

-
ChallengeDice: "Challenge dice"
+
ChallengeDice: "Challenge dice"

The player can pick and choose which challenge dice to reroll.

-
ChallengeDie: "Challenge die"
+
ChallengeDie: "Challenge die"

The player can choose one challenge die to reroll.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Moves.RollMethod.html b/docs/enums/Json_Moves.RollMethod.html index c5e504a64..d9502aeb0 100644 --- a/docs/enums/Json_Moves.RollMethod.html +++ b/docs/enums/Json_Moves.RollMethod.html @@ -1,20 +1,20 @@ RollMethod | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration RollMethod

The stat(s) or progress track(s) that may be rolled with the parent move trigger option.

-

Index

Enumeration Members

All: "All"
+

Index

Enumeration Members

All: "All"

When rolling with this move trigger option, every stat or progress track of the Using key is rolled.

-
Any: "Any"
+
Any: "Any"

When rolling with this move trigger option, the user picks which stat to use.

This is the default option for triggers that offer a single stat.

-
Highest: "Highest"
+
Highest: "Highest"

When rolling with this move trigger option, use the highest/best option from the Using key.

-
Inherit: "Inherit"
+
Inherit: "Inherit"

This move trigger option has no roll method of its own, and must inherit its roll from another move trigger option.

If the parent's Using is defined, the inherited roll must use one of those stats/progress tracks.

Typically appears on children of IAlterMove.

-
Lowest: "Lowest"
+
Lowest: "Lowest"

When rolling with this move trigger option, use the lowest/worst option from the Using key.

-
StrongHit: "Strong Hit"
+
StrongHit: "Strong Hit"

The move trigger option results in an automatic strong hit - no roll required.

-
WeakHit: "Weak Hit"
+
WeakHit: "Weak Hit"

The move trigger option results in an automatic weak hit - no roll required.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_Moves.RollType.html b/docs/enums/Json_Moves.RollType.html index 1ef4ad667..f4cb74a9b 100644 --- a/docs/enums/Json_Moves.RollType.html +++ b/docs/enums/Json_Moves.RollType.html @@ -1 +1 @@ -RollType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file +RollType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/Json_SettingTruths.SettingTruthName.html b/docs/enums/Json_SettingTruths.SettingTruthName.html index 7529554a9..09824078f 100644 --- a/docs/enums/Json_SettingTruths.SettingTruthName.html +++ b/docs/enums/Json_SettingTruths.SettingTruthName.html @@ -1 +1 @@ -SettingTruthName | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

ArtificialIntelligence: "Artificial Intelligence"
Cataclysm: "Cataclysm"
CommunicationAndData: "Communication and Data"
Communities: "Communities"
Exodus: "Exodus"
Horrors: "Horrors"
Iron: "Iron"
Laws: "Laws"
Lifeforms: "Lifeforms"
Magic: "Magic"
Medicine: "Medicine"
Precursors: "Precursors"
Religion: "Religion"
War: "War"

Generated using TypeDoc

\ No newline at end of file +SettingTruthName | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration Members

ArtificialIntelligence: "Artificial Intelligence"
Cataclysm: "Cataclysm"
CommunicationAndData: "Communication and Data"
Communities: "Communities"
Exodus: "Exodus"
Horrors: "Horrors"
Iron: "Iron"
Laws: "Laws"
Lifeforms: "Lifeforms"
Magic: "Magic"
Medicine: "Medicine"
Precursors: "Precursors"
Religion: "Religion"
War: "War"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 2d17948d9..b3b6db009 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Dataforged API

Dataforged v1.4.2

+Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Dataforged API

Dataforged v1.3.2

undefined undefined @@ -66,9 +66,6 @@

ESM

import { starforged } from 'dataforged'
 
-

If your project depends on something that doesn't support import assertions, you can instead use:

-
import { starforged } from 'dataforged/esm-no-assert'
-

CommonJS

diff --git a/docs/interfaces/Json_Assets.IAlterMomentum.html b/docs/interfaces/Json_Assets.IAlterMomentum.html index 7b5c0f2e7..4cb109f1b 100644 --- a/docs/interfaces/Json_Assets.IAlterMomentum.html +++ b/docs/interfaces/Json_Assets.IAlterMomentum.html @@ -1,5 +1,5 @@ -IAlterMomentum | Dataforged API

Hierarchy

  • IAlterMomentum

Index

Properties

Properties

+IAlterMomentum | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IAlterMomentum

Index

Properties

Properties

Information on how the player's momentum burn is altered.

-
+

Information on how the player's momentum reset is altered.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAlterMomentumBurn.html b/docs/interfaces/Json_Assets.IAlterMomentumBurn.html index 2e395a3bc..a67aeea61 100644 --- a/docs/interfaces/Json_Assets.IAlterMomentumBurn.html +++ b/docs/interfaces/Json_Assets.IAlterMomentumBurn.html @@ -1,5 +1,5 @@ -IAlterMomentumBurn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMomentumBurn

Hierarchy

  • IAlterMomentumBurn

Index

Properties

Effect: IHasText
+IAlterMomentumBurn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMomentumBurn

Hierarchy

  • IAlterMomentumBurn

Index

Properties

Effect: IHasText

The effect altering the PC's momentum burn.

-
Outcomes?: ("Weak Hit" | "Strong Hit")[]
Trigger: IHasText
+
Outcomes?: ("Weak Hit" | "Strong Hit")[]
Trigger: IHasText

The trigger condition for altering the PC's momentum burn.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAlterMomentumReset.html b/docs/interfaces/Json_Assets.IAlterMomentumReset.html index 148306964..88aa02c60 100644 --- a/docs/interfaces/Json_Assets.IAlterMomentumReset.html +++ b/docs/interfaces/Json_Assets.IAlterMomentumReset.html @@ -1,5 +1,5 @@ -IAlterMomentumReset | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMomentumReset

Hierarchy

  • IAlterMomentumReset

Index

Properties

Properties

Trigger: IHasText
+IAlterMomentumReset | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMomentumReset

Hierarchy

  • IAlterMomentumReset

Index

Properties

Properties

Trigger: IHasText

The trigger condition for altering the PC's momentum reset.

-
Value: number
+
Value: number

The amount by which the PC's momentum reset is change.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAlterMove.html b/docs/interfaces/Json_Assets.IAlterMove.html index 454b92fce..0a4cdf702 100644 --- a/docs/interfaces/Json_Assets.IAlterMove.html +++ b/docs/interfaces/Json_Assets.IAlterMove.html @@ -1,24 +1,24 @@ IAlterMove | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes alterations applied to moves by asset abilities.

-

Hierarchy

  • StubBy<IMove, "Trigger" | "Text", "Name" | "Category" | "Display" | "Source" | "Outcomes" | "Optional">
    • IAlterMove

Index

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[1-9][0-9]*$

-
Alters?: string[]
+

Hierarchy

  • StubBy<IMove, "Trigger" | "Text", "Name" | "Category" | "Display" | "Source" | "Outcomes" | "Optional">
    • IAlterMove

Index

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[1-9][0-9]*$

+
Alters?: string[]

Some asset abilities alter/extend other asset abilities, specified as an array of IDs. Only changed properties are specified; other properties are the same.

-
Asset?: string
+
Asset?: string

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

-
Moves?: null | string[]
+
Moves?: null | string[]

The $ids of the move(s) to be altered. If it's null, it can alter any move to which its trigger conditions apply. If it's undefined, see Extends instead.

-
nullable
Oracles?: string[]
+
nullable
Oracles?: string[]

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

-
+

Added rules text that applies on move outcomes.

-
Progress Move?: boolean
+
Progress Move?: boolean

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

-
Suggestions?: ISuggestions
+
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
+
Tags?: string[]
Text?: string

Markdown rules text describing added effects which apply before the move is rolled, such as adds.

-
Trigger?: IMoveTrigger
+
Trigger?: IMoveTrigger

The trigger required by the asset ability. If undefined, the move alteration applies to all uses of the specified moves, so long as they also meet any implicit asset requirements (fictional framing, IAsset.Requirement, not being Broken or Out of Action, etc).

-
Variant of?: string
+
Variant of?: string

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

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAlterMoveOutcomes.html b/docs/interfaces/Json_Assets.IAlterMoveOutcomes.html index 9905939f8..a50b217e4 100644 --- a/docs/interfaces/Json_Assets.IAlterMoveOutcomes.html +++ b/docs/interfaces/Json_Assets.IAlterMoveOutcomes.html @@ -1,2 +1,2 @@ -IAlterMoveOutcomes | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMoveOutcomes

Hierarchy

Index

Properties

$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$

-
Strong Hit?: IAlterOutcomeInfo

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +IAlterMoveOutcomes | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMoveOutcomes

Hierarchy

Index

Properties

$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$

+
Strong Hit?: IAlterOutcomeInfo

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAlterOutcomeInfo.html b/docs/interfaces/Json_Assets.IAlterOutcomeInfo.html index 0cd8a3e46..e5b7b3987 100644 --- a/docs/interfaces/Json_Assets.IAlterOutcomeInfo.html +++ b/docs/interfaces/Json_Assets.IAlterOutcomeInfo.html @@ -1,10 +1,10 @@ -IAlterOutcomeInfo | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterOutcomeInfo

Hierarchy

  • Omit<PartialDeep<IOutcomeInfo>, "With a Match">
    • IAlterOutcomeInfo

Index

Properties

$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)$

-
Count as?: Partial<undefined | "Miss" | "Weak Hit" | "Strong Hit">
+IAlterOutcomeInfo | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterOutcomeInfo

Hierarchy

  • Omit<PartialDeep<IOutcomeInfo>, "With a Match">
    • IAlterOutcomeInfo

Index

Properties

$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)$

+
Count as?: Partial<undefined | "Miss" | "Weak Hit" | "Strong Hit">

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

-
In Control?: Partial<undefined | boolean>
+
In Control?: Partial<undefined | 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.

-
Reroll?: Partial<undefined | IMoveReroll>
+
Reroll?: Partial<undefined | IMoveReroll>

Information on rerolls offered by this move.

-
Text?: string
+
Text?: string

The item's rules text as a markdown string.

-
markdown
With a Match?: Omit<IAlterOutcomeInfo, "With a Match">

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
markdown
With a Match?: Omit<IAlterOutcomeInfo, "With a Match">

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAsset.html b/docs/interfaces/Json_Assets.IAsset.html index fce2b8e2d..071830131 100644 --- a/docs/interfaces/Json_Assets.IAsset.html +++ b/docs/interfaces/Json_Assets.IAsset.html @@ -1,32 +1,32 @@ IAsset | Dataforged API
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"

+

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[]
+
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
+
Asset Type: string

The ID of the asset's parent AssetType

example

"Starforged/Assets/Path"

-
Attachments?: IAssetAttachment
+
Attachments?: IAssetAttachment

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

-
Condition Meter?: IConditionMeter
+
Condition Meter?: IConditionMeter

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

-
+

Data relevant to this item's display/rendering.

-
Inputs?: (IInputText | IInputSelect)[]
+
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
+
Name: string

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

example

"Bounty Hunter"

-
Requirement?: string
+
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
+
Source: ISource

Information on this item's source.

-
States?: IAssetState[]
+
States?: IAssetState[]

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

-
Tags?: string[]
+
Tags?: string[]

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

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAssetAbility.html b/docs/interfaces/Json_Assets.IAssetAbility.html index e5fb8a04e..e2efb52b5 100644 --- a/docs/interfaces/Json_Assets.IAssetAbility.html +++ b/docs/interfaces/Json_Assets.IAssetAbility.html @@ -1,20 +1,20 @@ IAssetAbility | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents one of an asset's three abilities.

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Alter Momentum?: IAlterMomentum
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Alter Momentum?: IAlterMomentum

Information on how this ability alters its owner's momentum (triggers an effect on burn, on reset, etc)

-
Alter Moves?: IAlterMove[]
+
Alter Moves?: IAlterMove[]

Information on how this ability alters moves when enabled.

-
Alter Properties?: IAssetAlterProperties
+
Alter Properties?: IAssetAlterProperties

Information on how this ability alters its parent asset when enabled.

-
Enabled: boolean
+
Enabled: boolean

Whether the asset ability is enabled or not. In most cases, the first asset ability defaults to 'true' and the others to 'false'. If none of an asset's abilities are set to 'true', the player can pick which the ability they start with when purchasing the asset.

-
+

User inputs (text, clocks, etc) associated with this asset ability.

-
Moves?: IMove[]
+
Moves?: IMove[]

New moves added by this asset ability.

-
Name?: string
+
Name?: string

Ironsworn companion assets provide names for their abilities. Starforged asset abilities do not have names.

-
Text: string
+
Text: string

The item's rules text as a markdown string.

markdown

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAssetAlterProperties.html b/docs/interfaces/Json_Assets.IAssetAlterProperties.html index a469ae820..c611482e0 100644 --- a/docs/interfaces/Json_Assets.IAssetAlterProperties.html +++ b/docs/interfaces/Json_Assets.IAssetAlterProperties.html @@ -3,31 +3,31 @@
example

An IAssetAlterProperties that would set IAsset["Condition Meter"].Max to 3, and leave its other properties unchanged:

{ "Condition Meter": { Max: 3 } }
 
-

Hierarchy

  • PartialDeep<IAsset>
    • IAssetAlterProperties

Index

Properties

$id?: string
example

"Starforged/Assets/Path/Bounty_Hunter"

+

Hierarchy

  • PartialDeep<IAsset>
    • IAssetAlterProperties

Index

Properties

$id?: string
example

"Starforged/Assets/Path/Bounty_Hunter"

pattern

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

-
+

The asset's abilities.

-
Aliases?: Partial<undefined | string[]>
+
Aliases?: Partial<undefined | 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
+
Asset Type?: string

The ID of the asset's parent AssetType

example

"Starforged/Assets/Path"

-
Attachments?: Partial<undefined | IAssetAttachment>
+
Attachments?: Partial<undefined | IAssetAttachment>

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

-
Condition Meter?: Partial<undefined | IConditionMeter>
+
Condition Meter?: Partial<undefined | IConditionMeter>

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

-
Display?: Partial<IDisplayWithTitle>
Inputs?: Partial<undefined | (IInputText | IInputSelect)[]>
+
Display?: Partial<IDisplayWithTitle>
Inputs?: Partial<undefined | (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
+
Name?: string

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

example

"Bounty Hunter"

-
Requirement?: Partial<undefined | string>
+
Requirement?: Partial<undefined | 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?: Partial<ISource>
+
Source?: Partial<ISource>

Information on this item's source.

-
States?: Partial<undefined | IAssetState[]>
+
States?: Partial<undefined | IAssetState[]>

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

-
Tags?: Partial<undefined | string[]>
Usage?: Partial<IAssetUsage>
+
Tags?: Partial<undefined | string[]>
Usage?: Partial<IAssetUsage>

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

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAssetAttachment.html b/docs/interfaces/Json_Assets.IAssetAttachment.html index 4555fe965..17257b6e9 100644 --- a/docs/interfaces/Json_Assets.IAssetAttachment.html +++ b/docs/interfaces/Json_Assets.IAssetAttachment.html @@ -1,7 +1,7 @@ IAssetAttachment | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Details which assets are valid attachments. The most prominent example in Ironsworn: Starforged is the STARSHIP asset (Starship/Assets/Command_Vehicle/Starship); Rover (Starship/Assets/Support_Vehicle/Rover) also has an elective ability that adds this property.

-

Hierarchy

  • IAssetAttachment

Index

Properties

Properties

Asset Types: string[]
+

Hierarchy

  • IAssetAttachment

Index

Properties

Properties

Asset Types: string[]

The type of asset that this asset accepts as attachments.

-
Max: null | number
+
Max: null | number

The maximum number of attached assets accepted by this asset. If undefined or null, there is no maximum.

nullable

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAssetState.html b/docs/interfaces/Json_Assets.IAssetState.html index f54bd2a3e..d0a073c71 100644 --- a/docs/interfaces/Json_Assets.IAssetState.html +++ b/docs/interfaces/Json_Assets.IAssetState.html @@ -1,16 +1,16 @@ IAssetState | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes a possible state for an asset, like the "Broken" status for certain assets (mainly Modules in Starforged).

States are frequently toggled on and off by players; for real-world gameplay, this is generally represented by flipping the card over. A checkbox or other on/off toggle might serve the same function in a digital implementation.

-

Hierarchy

Index

Properties

Disables asset: boolean
+

Hierarchy

Index

Properties

Disables asset: boolean

Whether this state should disable the entire asset when IAssetState.Enabled === true

-
Enabled: boolean
+
Enabled: boolean

Whether this state is currently enabled.

-
Impact: boolean
+
Impact: boolean

Whether this state counts as an Impact for the asset's owner.

Note that for vehicles, this shouldn't be applied automatically unless your implementation has some way of telling which vehicle the PC is currently using.

-
Name: string
+
Name: string

A string label name or label for the state.

example

"Broken"

-
Permanent: boolean
+
Permanent: boolean

Whether or not this state is permanent.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAssetType.html b/docs/interfaces/Json_Assets.IAssetType.html index 1c2d507e5..2b1a695be 100644 --- a/docs/interfaces/Json_Assets.IAssetType.html +++ b/docs/interfaces/Json_Assets.IAssetType.html @@ -1,18 +1,18 @@ IAssetType | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents an Asset Type such as Command Vehicle, Companion, or Path, and serves as a container for all assets of that type.

-

Hierarchy

Index

Properties

$id: string
example

"Ironsworn/Assets/Ritual"

+

Hierarchy

Index

Properties

$id: string
example

"Ironsworn/Assets/Ritual"

example

"Starforged/Assets/Command_Vehicle"

pattern

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

-
Aliases?: string[]
+
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.

-
Assets: IAsset[]
+
Assets: IAsset[]

The assets that belong to this asset type.

-
Description: string
+
Description: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Name: string
example

"Ritual"

+
Name: string
example

"Ritual"

example

"Command Vehicle"

-
Source: ISource
+
Source: ISource

Information on this item's source.

-

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IAssetUsage.html b/docs/interfaces/Json_Assets.IAssetUsage.html index 1091e6e2d..b41e76326 100644 --- a/docs/interfaces/Json_Assets.IAssetUsage.html +++ b/docs/interfaces/Json_Assets.IAssetUsage.html @@ -1,4 +1,4 @@ -IAssetUsage | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IAssetUsage

Index

Properties

Properties

Shared: boolean
+IAssetUsage | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IAssetUsage

Index

Properties

Properties

Shared: boolean

Whether the asset's abilities are shared with Allies.

If set to true, the asset's abilities can be invoked by any player character; if your app facilitates co-op or guided play, consider how you might expose these abilities to players other than the asset's owner.

Defaults to true for Command Vehicle, Support Vehicle, and Module assets.

diff --git a/docs/interfaces/Json_Assets.IInput.html b/docs/interfaces/Json_Assets.IInput.html index 62024aecc..886af8de0 100644 --- a/docs/interfaces/Json_Assets.IInput.html +++ b/docs/interfaces/Json_Assets.IInput.html @@ -1,11 +1,11 @@ IInput | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

A stub interface representing an input widget of any type.

see

IInputNumber, IInputClock, IInputText, IInputSelect

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Adjustable: boolean
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Adjustable: boolean

Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically false, while something like a clock or tally would be true.

It's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality "front and center" or as a secondary interaction (via long press, right click, etc);

-
Input Type: InputType
Name: string
+
Input Type: InputType
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.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputClock.html b/docs/interfaces/Json_Assets.IInputClock.html index 459172ac4..0392497db 100644 --- a/docs/interfaces/Json_Assets.IInputClock.html +++ b/docs/interfaces/Json_Assets.IInputClock.html @@ -2,18 +2,18 @@

An input representing an Ironsworn: Starforged clock.

page

239

see

InputType.Clock

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Adjustable: boolean
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Adjustable: boolean

Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically false, while something like a clock or tally would be true.

It's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality "front and center" or as a secondary interaction (via long press, right click, etc);

-
Clock Type: ClockType
+
Clock Type: ClockType

Whether the clock is a Tension Clock or a Campaign Clock. For assets this doesn't really matter since they have their own specific trigger conditions, and can probably be ignored.

-
Filled: number
+
Filled: number

An integer representing how many filled segments this clock has. This is always 0 in Dataforged; it's included to make it easy to store clock states with the same interface.

-
Input Type: Clock
Name: string
+
Input Type: Clock
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.

-
Segments: ClockSegments
+
Segments: ClockSegments

An integer representing the total number of segments in this Clock. Ironsworn: Starforged uses clocks with 4, 6, 8, and 10 segments.

Filled should not exceed this number.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputNumber.html b/docs/interfaces/Json_Assets.IInputNumber.html index dcb43de8f..226c68cbd 100644 --- a/docs/interfaces/Json_Assets.IInputNumber.html +++ b/docs/interfaces/Json_Assets.IInputNumber.html @@ -2,11 +2,11 @@

An input where the user sets an integer. Suggested rendering: a number input spinner, similar to <input type='number'> in HTML.

see

InputType.Number

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Adjustable: boolean
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Adjustable: boolean

Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically false, while something like a clock or tally would be true.

It's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality "front and center" or as a secondary interaction (via long press, right click, etc);

-
Input Type: Number
Max: null | number
nullable
Min: number
Name: string
+
Input Type: Number
Max: null | number
nullable
Min: number
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.

-
Step: 1
Value: number

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
Step: 1
Value: number

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelect.html b/docs/interfaces/Json_Assets.IInputSelect.html index d91b2ce65..790d21dff 100644 --- a/docs/interfaces/Json_Assets.IInputSelect.html +++ b/docs/interfaces/Json_Assets.IInputSelect.html @@ -3,13 +3,13 @@ Suggested rendering: a drop-down selection menu.

example
{
"Name": "Material",
"Input Type": "Select",
"Attributes": [
{ "Key": "Stat", "Type": "Stat" },
{ "Key": "Condition Meter", "Type": "Condition Meter" }
],
"Options": [
{
"Name": "Thunderwood",
"Sets": [
{ "Key": "Stat", "Value": "Edge" },
{ "Key": "Condition Meter", "Value": "Health" }
]
}
]
}
-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Adjustable: boolean
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Adjustable: boolean

Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically false, while something like a clock or tally would be true.

It's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality "front and center" or as a secondary interaction (via long press, right click, etc);

-
Input Type: Select
Name: string
+
Input Type: Select
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.

-
+

Hints which attribute(s) set by this dropdown's options.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelectAttributeDefinition.html b/docs/interfaces/Json_Assets.IInputSelectAttributeDefinition.html index 72d7f239c..d7ef69344 100644 --- a/docs/interfaces/Json_Assets.IInputSelectAttributeDefinition.html +++ b/docs/interfaces/Json_Assets.IInputSelectAttributeDefinition.html @@ -1,4 +1,4 @@ IInputSelectAttributeDefinition | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectAttributeDefinition

Provides hints for the keys and typing of an IInputSelect's child IInputSelectOptions.

typeparam V

The type(s) of the value(s) set by this item's options.

-

Hierarchy

  • IInputSelectAttributeDefinition

Index

Properties

Properties

Key: string

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Key: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelectOption.html b/docs/interfaces/Json_Assets.IInputSelectOption.html index efb904b50..15b7041fd 100644 --- a/docs/interfaces/Json_Assets.IInputSelectOption.html +++ b/docs/interfaces/Json_Assets.IInputSelectOption.html @@ -1,9 +1,9 @@ IInputSelectOption | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectOption

Represents an option in an IInputSelect.

-

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

-
Name: string
+

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

+
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.

-
+

A array describing what attribute keys should be set to when this option is active. All items in the array should be set in this manner.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelectOptionSetter.html b/docs/interfaces/Json_Assets.IInputSelectOptionSetter.html index b74f81521..36ef17d69 100644 --- a/docs/interfaces/Json_Assets.IInputSelectOptionSetter.html +++ b/docs/interfaces/Json_Assets.IInputSelectOptionSetter.html @@ -1,2 +1,2 @@ -IInputSelectOptionSetter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectOptionSetter

Generated using TypeDoc

\ No newline at end of file +IInputSelectOptionSetter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectOptionSetter

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelectOptionSetterMeter.html b/docs/interfaces/Json_Assets.IInputSelectOptionSetterMeter.html index 3a259b1f5..72755286b 100644 --- a/docs/interfaces/Json_Assets.IInputSelectOptionSetterMeter.html +++ b/docs/interfaces/Json_Assets.IInputSelectOptionSetterMeter.html @@ -1,4 +1,4 @@ IInputSelectOptionSetterMeter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectOptionSetterMeter

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

+
Key: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelectOptionSetterNumber.html b/docs/interfaces/Json_Assets.IInputSelectOptionSetterNumber.html index 7a33d51b1..66a01ea25 100644 --- a/docs/interfaces/Json_Assets.IInputSelectOptionSetterNumber.html +++ b/docs/interfaces/Json_Assets.IInputSelectOptionSetterNumber.html @@ -1,4 +1,4 @@ IInputSelectOptionSetterNumber | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectOptionSetterNumber

An integer value set by an IInputSelectOption.

-

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

-
Key: string
Type: Number
Value: number

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

+
Key: string
Type: Number
Value: number

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelectOptionSetterStat.html b/docs/interfaces/Json_Assets.IInputSelectOptionSetterStat.html index f5a9dc179..13a922527 100644 --- a/docs/interfaces/Json_Assets.IInputSelectOptionSetterStat.html +++ b/docs/interfaces/Json_Assets.IInputSelectOptionSetterStat.html @@ -1,4 +1,4 @@ IInputSelectOptionSetterStat | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectOptionSetterStat

A stat set by an IInputSelectOption.

-

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

-
Key: string
Type: Stat
Value: Stat

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

+
Key: string
Type: Stat
Value: Stat

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputSelectOptionSetterString.html b/docs/interfaces/Json_Assets.IInputSelectOptionSetterString.html index 1985b5f53..0bef26193 100644 --- a/docs/interfaces/Json_Assets.IInputSelectOptionSetterString.html +++ b/docs/interfaces/Json_Assets.IInputSelectOptionSetterString.html @@ -1,4 +1,4 @@ IInputSelectOptionSetterString | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IInputSelectOptionSetterString

An arbitrary string value set by an IInputSelectOption.

-

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

-
Key: string
Type: String
Value: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id: string
pattern

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

+
Key: string
Type: String
Value: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Assets.IInputText.html b/docs/interfaces/Json_Assets.IInputText.html index a01a3e813..7d705c187 100644 --- a/docs/interfaces/Json_Assets.IInputText.html +++ b/docs/interfaces/Json_Assets.IInputText.html @@ -2,11 +2,11 @@

A text input. Suggested rendering: a single-line text input, similar to <input type='text'> in HTML.

see

InputType.Text

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Adjustable: boolean
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Adjustable: boolean

Whether the input's value is expected to change over the course of a campaign. For example, name fields are typically false, while something like a clock or tally would be true.

It's a good idea to make everything editable regardless, but this property might inform whether your UI presents that functionality "front and center" or as a secondary interaction (via long press, right click, etc);

-
Input Type: Text
Name: string
+
Input Type: Text
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.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Common.IConditionMeter.html b/docs/interfaces/Json_Common.IConditionMeter.html index 5fce6b72d..1ac677b96 100644 --- a/docs/interfaces/Json_Common.IConditionMeter.html +++ b/docs/interfaces/Json_Common.IConditionMeter.html @@ -1,15 +1,15 @@ IConditionMeter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface representing a condition meter such as Health, Spirit, Supply, or Integrity.

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Aliases?: MeterAlias[]
Conditions: MeterCondition[]
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Aliases?: MeterAlias[]
Conditions: MeterCondition[]

The conditions that can apply to this meter.

-
Max: number
+
Max: number

The maximum value of the meter.

-
Min: 0
+
Min: 0

The minimum value of the meter. Usually this is 0. Momentum is currently the only exception to this and goes as low as -6.

-
Name: 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.

-
Value: number
+
Value: number

The initial value of the meter.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Common.ICustomStat.html b/docs/interfaces/Json_Common.ICustomStat.html index 168243981..5f42a42dc 100644 --- a/docs/interfaces/Json_Common.ICustomStat.html +++ b/docs/interfaces/Json_Common.ICustomStat.html @@ -1,5 +1,5 @@ -ICustomStat | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[0-9]+)/[A-z_-]+/Trigger/Options/[0-9]+/Custom_stat$

-
Name: string
+ICustomStat | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[0-9]+)/[A-z_-]+/Trigger/Options/[0-9]+/Custom_stat$

+
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.

-

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Common.ICustomStatOption.html b/docs/interfaces/Json_Common.ICustomStatOption.html index 5be1fcb90..77bb50098 100644 --- a/docs/interfaces/Json_Common.ICustomStatOption.html +++ b/docs/interfaces/Json_Common.ICustomStatOption.html @@ -1,6 +1,6 @@ -ICustomStatOption | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICustomStatOption

Hierarchy

Index

Properties

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[0-9]+)/[A-z_-]+/Trigger/Options/[0-9]+/Custom_stat/[A-z_-]+$

-
Name: string
+ICustomStatOption | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICustomStatOption

Hierarchy

Index

Properties

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Moves/([A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[0-9]+)/[A-z_-]+/Trigger/Options/[0-9]+/Custom_stat/[A-z_-]+$

+
Name: string

The name/label for this specific value of the custom stat.

-
Value: number
+
Value: number

The numeric value to be used as +stat when making an Action Roll.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Common.IMeterBase.html b/docs/interfaces/Json_Common.IMeterBase.html index 5db8d7884..3dcd5b751 100644 --- a/docs/interfaces/Json_Common.IMeterBase.html +++ b/docs/interfaces/Json_Common.IMeterBase.html @@ -1,15 +1,15 @@ IMeterBase | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface representing a Meter.

-

Hierarchy

Index

Properties

$id: string
+

Hierarchy

Index

Properties

$id: string

The item's unique string ID.

pattern

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

-
Max: number
+
Max: number

The maximum value of the meter.

-
Min: number
+
Min: number

The minimum value of the meter. Usually this is 0. Momentum is currently the only exception to this and goes as low as -6.

-
Name: 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.

-
Value: number
+
Value: number

The initial value of the meter.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.ICyclopediaEntry.html b/docs/interfaces/Json_Cyclopedia.ICyclopediaEntry.html index 7fd0c8708..655448508 100644 --- a/docs/interfaces/Json_Cyclopedia.ICyclopediaEntry.html +++ b/docs/interfaces/Json_Cyclopedia.ICyclopediaEntry.html @@ -1,17 +1,17 @@ ICyclopediaEntry | Dataforged API
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
+

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
+
markdown
Display: IDisplay

Data relevant to this item's display/rendering.

-
Features?: string[]
Name: string
+
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
+
Quest Starter?: string

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

-
markdown
Source: ISource
+
markdown
Source: ISource

Information on this item's source.

-
Summary?: string
+
Summary?: string

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

-
markdown
Tags?: string[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
markdown
Tags?: string[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.IEncounter.html b/docs/interfaces/Json_Cyclopedia.IEncounter.html index 71ef0312c..1e02b08db 100644 --- a/docs/interfaces/Json_Cyclopedia.IEncounter.html +++ b/docs/interfaces/Json_Cyclopedia.IEncounter.html @@ -1,18 +1,18 @@ IEncounter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a full (i.e. not a stub/variant) encounter entry in Ironsworn or Ironsworn: Starforged.

-

Hierarchy

Index

Properties

$id: string
example

"Starforged/Encounters/Chiton"

+

Hierarchy

Index

Properties

$id: string
example

"Starforged/Encounters/Chiton"

pattern

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

-
Description: string
+
Description: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Drives: string[]
Features: string[]
Name: string
example

"Chiton"

-
example

"Monster"

-
Quest Starter: string
+
Drives: string[]
Features: string[]
Name: string
example

"Chiton"

+
example

"Monster"

+
Quest Starter: string

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

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Summary?: string
example

"Insectoid horde"

-
markdown
Tactics: string[]
Tags?: Vehicle[]
Your Truth?: string
+
Summary?: string
example

"Insectoid horde"

+
markdown
Tactics: string[]
Tags?: Vehicle[]
Your Truth?: string

A markdown string representing the text of the "Your Truth" callout box included with some Ironsworn encounters.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.IEncounterBase.html b/docs/interfaces/Json_Cyclopedia.IEncounterBase.html index 44ced4e6f..1a39dc5c0 100644 --- a/docs/interfaces/Json_Cyclopedia.IEncounterBase.html +++ b/docs/interfaces/Json_Cyclopedia.IEncounterBase.html @@ -1,20 +1,20 @@ IEncounterBase | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface common to Encounter entries in Ironsworn and Ironsworn: Starforged, plus 'stubs' like IEncounterVariant.

see

IEncounter, IEncounterVariant

-

Hierarchy

Index

Properties

$id: string
example

"Starforged/Encounters/Chiton"

+

Hierarchy

Index

Properties

$id: string
example

"Starforged/Encounters/Chiton"

pattern

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

-
Description: string
+
Description: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Drives?: string[]
markdown
Features?: string[]
markdown
Name: string
example

"Chiton"

-
example

"Monster"

-
Quest Starter?: string
+
Drives?: string[]
markdown
Features?: string[]
markdown
Name: string
example

"Chiton"

+
example

"Monster"

+
Quest Starter?: string

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

-
markdown
Source: ISource
+
markdown
Source: ISource

Information on this item's source.

-
Summary?: string
example

"Insectoid horde"

-
markdown
Tactics?: string[]
markdown
Tags?: Vehicle[]
Your Truth?: string
+
Summary?: string
example

"Insectoid horde"

+
markdown
Tactics?: string[]
markdown
Tags?: Vehicle[]
Your Truth?: string

Ironsworn, p. 135: "Some NPCs include a question for you to answer. This is an opportunity to customize the NPC to your vision of the Ironlands. You can do this as you define your world or discover through play. Truths may represent an absolute fact, or merely something the people of your world believe."

Only present in Ironsworn encounters.

markdown

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.IEncounterIronsworn.html b/docs/interfaces/Json_Cyclopedia.IEncounterIronsworn.html index a13b16da9..7d397bf89 100644 --- a/docs/interfaces/Json_Cyclopedia.IEncounterIronsworn.html +++ b/docs/interfaces/Json_Cyclopedia.IEncounterIronsworn.html @@ -1,15 +1,15 @@ IEncounterIronsworn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents an Ironsworn Encounter entry.

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Description: string
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Description: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Drives: string[]
Features: string[]
Name: string
example

"Chiton"

-
Quest Starter: string
+
Drives: string[]
Features: string[]
Name: string
example

"Chiton"

+
Quest Starter: string

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

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Summary?: string
Tactics: string[]
Tags?: Vehicle[]
Your Truth?: string
+
Summary?: string
Tactics: string[]
Tags?: Vehicle[]
Your Truth?: string

A markdown string representing the text of the "Your Truth" callout box included with some Ironsworn encounters.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.IEncounterNatureInfo.html b/docs/interfaces/Json_Cyclopedia.IEncounterNatureInfo.html index 1c5cd6a37..fd60b3bb0 100644 --- a/docs/interfaces/Json_Cyclopedia.IEncounterNatureInfo.html +++ b/docs/interfaces/Json_Cyclopedia.IEncounterNatureInfo.html @@ -1,15 +1,15 @@ IEncounterNatureInfo | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the metadata describing an Ironsworn encounter's nature; used as a category to contain all Encounters of that type.

-

Hierarchy

Index

Properties

$id: string
pattern

^Ironsworn/Encounters/[A-z_-]+$

-
Description: string
+

Hierarchy

Index

Properties

$id: string
pattern

^Ironsworn/Encounters/[A-z_-]+$

+
Description: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Encounters: IEncounterIronsworn[]
+
Encounters: IEncounterIronsworn[]

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.

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Summary: string
+
Summary: string

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

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.IEncounterStarforged.html b/docs/interfaces/Json_Cyclopedia.IEncounterStarforged.html index 5f2966ef9..0309448d0 100644 --- a/docs/interfaces/Json_Cyclopedia.IEncounterStarforged.html +++ b/docs/interfaces/Json_Cyclopedia.IEncounterStarforged.html @@ -1,15 +1,15 @@ IEncounterStarforged | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents an Ironsworn: Starforged Encounter entry.

-

Hierarchy

Index

Properties

$id: string
pattern

^Starforged/Encounters/[A-z_-]+$

-
Description: string
+

Hierarchy

Index

Properties

$id: string
pattern

^Starforged/Encounters/[A-z_-]+$

+
Description: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Drives: string[]
Features: string[]
Name: string
example

"Chiton"

-
Quest Starter: string
+
Drives: string[]
Features: string[]
Name: string
example

"Chiton"

+
Quest Starter: string

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

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Summary: string
Tactics: string[]
Tags?: Vehicle[]
Variants: IEncounterVariant[]
Your Truth?: string
+
Summary: string
Tactics: string[]
Tags?: Vehicle[]
Variants: IEncounterVariant[]
Your Truth?: string

A markdown string representing the text of the "Your Truth" callout box included with some Ironsworn encounters.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.IEncounterVariant.html b/docs/interfaces/Json_Cyclopedia.IEncounterVariant.html index 0a8bc1447..390524595 100644 --- a/docs/interfaces/Json_Cyclopedia.IEncounterVariant.html +++ b/docs/interfaces/Json_Cyclopedia.IEncounterVariant.html @@ -1,9 +1,9 @@ IEncounterVariant | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a variant encounter 'stubs' included with a parent encounter in Ironsworn: Starforged.

-

Hierarchy

  • StubBy<IEncounterStarforged, never, "Features" | "Drives" | "Tactics" | "Variants" | "Summary" | "Your Truth" | "Quest Starter">
    • IEncounterVariant

Index

Properties

$id: string
pattern

^Starforged/Encounters/[A-z_-]+/[A-z_-]+$

-
Description: string
+

Hierarchy

  • StubBy<IEncounterStarforged, never, "Features" | "Drives" | "Tactics" | "Variants" | "Summary" | "Your Truth" | "Quest Starter">
    • IEncounterVariant

Index

Properties

$id: string
pattern

^Starforged/Encounters/[A-z_-]+/[A-z_-]+$

+
Description: string

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

-
markdown
Name: string
example

"Chiton"

-
Source: ISource
+
markdown
Name: string
example

"Chiton"

+
Source: ISource

Information on this item's source.

-
Tags?: Vehicle[]
Variant of: string

Generated using TypeDoc

\ No newline at end of file +
Tags?: Vehicle[]
Variant of: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Cyclopedia.IIronswornRegion.html b/docs/interfaces/Json_Cyclopedia.IIronswornRegion.html index 384c35aa6..fec6b541a 100644 --- a/docs/interfaces/Json_Cyclopedia.IIronswornRegion.html +++ b/docs/interfaces/Json_Cyclopedia.IIronswornRegion.html @@ -1,15 +1,15 @@ -IIronswornRegion | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$id: string
pattern

^Ironsworn/Regions/[A-z_-]$

-
Description: string
+IIronswornRegion | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$id: string
pattern

^Ironsworn/Regions/[A-z_-]$

+
Description: string

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

-
markdown
Display: IDisplay
+
markdown
Display: IDisplay

Data relevant to this item's display/rendering.

-
Features: string[]
Name: string
+
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
+
Quest Starter: string

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

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Summary: string
+
Summary: string

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

-
Tags?: string[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
Tags?: string[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_GameObjects.IAttribute.html b/docs/interfaces/Json_GameObjects.IAttribute.html index 28b4593d2..ce95f26fa 100644 --- a/docs/interfaces/Json_GameObjects.IAttribute.html +++ b/docs/interfaces/Json_GameObjects.IAttribute.html @@ -3,4 +3,4 @@

Attributes exist to describe prerequisites that might be fulfilled by more than one table, that don't exist on tables at all, or that a generated game object might want to 'force' as one of it's roll results.

See documentation for a list of available values.

see

AttributeKey, Atmosphere, Authority, Behavior, CreatureScale, DerelictType, Disposition, Dominion, Environment, FactionType, FringeGroup, Guild, Influence, Leadership, Life, Location, LocationTheme, PlanetaryClass, Population, Region, Role, SettlementInitialContact, StarshipInitialContact, Zone

-

Hierarchy

Index

Properties

Properties

Value?: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Value?: string

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_GameObjects.IAttributeChoices.html b/docs/interfaces/Json_GameObjects.IAttributeChoices.html index 0e054a1a1..c7791928b 100644 --- a/docs/interfaces/Json_GameObjects.IAttributeChoices.html +++ b/docs/interfaces/Json_GameObjects.IAttributeChoices.html @@ -1 +1 @@ -IAttributeChoices | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file +IAttributeChoices | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_GameObjects.IAttributeMaster.html b/docs/interfaces/Json_GameObjects.IAttributeMaster.html index e8ff8b98c..74299f284 100644 --- a/docs/interfaces/Json_GameObjects.IAttributeMaster.html +++ b/docs/interfaces/Json_GameObjects.IAttributeMaster.html @@ -1 +1 @@ -IAttributeMaster | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu
alpha

Hierarchy

  • IAttributeMaster

Index

Properties

Atmosphere: Atmosphere
Authority: Authority
Creature Scale: CreatureScale
Derelict Type: DerelictType
Disposition: Disposition
Dominion: Dominion
Encountered Behavior: Behavior
Environment: Environment
Faction Type: FactionType
Fringe Group: FringeGroup
Guild: Guild
Influence: Influence
Leadership: Leadership
Life: Life
Location: Location
Location Theme: LocationTheme
Planetary Class: PlanetaryClass
Population: Population
Region: Region
Role: Role
Zone: Zone

Generated using TypeDoc

\ No newline at end of file +IAttributeMaster | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu
alpha

Hierarchy

  • IAttributeMaster

Index

Properties

Atmosphere: Atmosphere
Authority: Authority
Creature Scale: CreatureScale
Derelict Type: DerelictType
Disposition: Disposition
Dominion: Dominion
Encountered Behavior: Behavior
Environment: Environment
Faction Type: FactionType
Fringe Group: FringeGroup
Guild: Guild
Influence: Influence
Leadership: Leadership
Life: Life
Location: Location
Location Theme: LocationTheme
Planetary Class: PlanetaryClass
Population: Population
Region: Region
Role: Role
Zone: Zone

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_GameObjects.IGameObject.html b/docs/interfaces/Json_GameObjects.IGameObject.html index 90596772a..04096eba3 100644 --- a/docs/interfaces/Json_GameObjects.IGameObject.html +++ b/docs/interfaces/Json_GameObjects.IGameObject.html @@ -1,3 +1,3 @@ IGameObject | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes a game object, with optional required parameters (for example, a specific Location result).

-

Hierarchy

  • IGameObject

Index

Properties

Object type: GameObjectType
Requires?: IRequirements

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Object type: GameObjectType
Requires?: IRequirements

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IDisplay.html b/docs/interfaces/Json_Meta.IDisplay.html index 9262601a3..1534a8787 100644 --- a/docs/interfaces/Json_Meta.IDisplay.html +++ b/docs/interfaces/Json_Meta.IDisplay.html @@ -1,14 +1,14 @@ IDisplay | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for data relevant to an item's display/rendering.

-

Hierarchy

Index

Properties

Color?: string
+

Hierarchy

Index

Properties

Color?: string

A hex color associated with this item, for use as e.g. an accent color in its display.

pattern

^#[A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9]$

-
Icon?: string
+
Icon?: string

A URL pointing to a single SVG icon.

pattern

^../../img/vector/[A-z-_0-9/]+.svg$

-
Images?: string[]
+
Images?: string[]

An array of URLs pointing to one or more WEBP images.

pattern

^../../img/raster/[A-z-_0-9/]+.webp$

-
Title?: string
+
Title?: string

The title of this item as it appears printed in the rulebook. Intended for use as the item's header, label, etc.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IDisplayWithTitle.html b/docs/interfaces/Json_Meta.IDisplayWithTitle.html index 417ddc198..067ce69da 100644 --- a/docs/interfaces/Json_Meta.IDisplayWithTitle.html +++ b/docs/interfaces/Json_Meta.IDisplayWithTitle.html @@ -1,12 +1,12 @@ -IDisplayWithTitle | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDisplayWithTitle

Hierarchy

Index

Properties

Color?: string
+IDisplayWithTitle | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IDisplayWithTitle

Hierarchy

Index

Properties

Color?: string

A hex color associated with this item, for use as e.g. an accent color in its display.

pattern

^#[A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9]$

-
Icon?: string
+
Icon?: string

A URL pointing to a single SVG icon.

pattern

^../../img/vector/[A-z-_0-9/]+.svg$

-
Images?: string[]
+
Images?: string[]

An array of URLs pointing to one or more WEBP images.

pattern

^../../img/raster/[A-z-_0-9/]+.webp$

-
Title: string
+
Title: string

The title of this item as it appears printed in the rulebook. Intended for use as the item's header, label, etc.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasAliases.html b/docs/interfaces/Json_Meta.IHasAliases.html index fbd2fb2c6..17d92a2cc 100644 --- a/docs/interfaces/Json_Meta.IHasAliases.html +++ b/docs/interfaces/Json_Meta.IHasAliases.html @@ -1,5 +1,5 @@ IHasAliases | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for items with aliases.

-

Hierarchy

  • IHasAliases

Index

Properties

Properties

Aliases: string[]
+

Hierarchy

  • IHasAliases

Index

Properties

Properties

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.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasDescription.html b/docs/interfaces/Json_Meta.IHasDescription.html index ffdd234b4..323be8719 100644 --- a/docs/interfaces/Json_Meta.IHasDescription.html +++ b/docs/interfaces/Json_Meta.IHasDescription.html @@ -1,5 +1,5 @@ IHasDescription | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasDescription

Interface for items with a user-facing markdown description, consisting of one or more paragraphs.

-

Hierarchy

Index

Properties

Properties

Description: string
+

Hierarchy

Index

Properties

Properties

Description: string

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

markdown

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasDisplay.html b/docs/interfaces/Json_Meta.IHasDisplay.html index b2bda9174..50e22d47b 100644 --- a/docs/interfaces/Json_Meta.IHasDisplay.html +++ b/docs/interfaces/Json_Meta.IHasDisplay.html @@ -1,5 +1,5 @@ IHasDisplay | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasGameObjects.html b/docs/interfaces/Json_Meta.IHasGameObjects.html index c66cdda33..9e2cd1778 100644 --- a/docs/interfaces/Json_Meta.IHasGameObjects.html +++ b/docs/interfaces/Json_Meta.IHasGameObjects.html @@ -1,5 +1,5 @@ IHasGameObjects | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasGameObjects

Interface for items that have associated game objects.

-

Hierarchy

  • IHasGameObjects

Index

Properties

Properties

Game objects: IGameObject[]
+

Hierarchy

  • IHasGameObjects

Index

Properties

Properties

Game objects: IGameObject[]

Any game objects that are explicitly pointed to by the original text. For most implementations, it is not recommended to generate them automatically - see "Peeling the Onion", p. 293.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasId.html b/docs/interfaces/Json_Meta.IHasId.html index ea3a6eb07..c9f9bc601 100644 --- a/docs/interfaces/Json_Meta.IHasId.html +++ b/docs/interfaces/Json_Meta.IHasId.html @@ -1,6 +1,6 @@ IHasId | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasName.html b/docs/interfaces/Json_Meta.IHasName.html index 95e11c5fc..3f0425888 100644 --- a/docs/interfaces/Json_Meta.IHasName.html +++ b/docs/interfaces/Json_Meta.IHasName.html @@ -1,6 +1,6 @@ IHasName | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for items with a Name key.

-

Hierarchy

Index

Properties

Properties

Name: string
+

Hierarchy

Index

Properties

Properties

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.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasOptional.html b/docs/interfaces/Json_Meta.IHasOptional.html index bfe89238d..8af01f700 100644 --- a/docs/interfaces/Json_Meta.IHasOptional.html +++ b/docs/interfaces/Json_Meta.IHasOptional.html @@ -1,4 +1,4 @@ -IHasOptional | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

Optional: boolean
+IHasOptional | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Properties

Optional: boolean

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

default

false

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasOracleContent.html b/docs/interfaces/Json_Meta.IHasOracleContent.html index 092a5cd5e..1e937695d 100644 --- a/docs/interfaces/Json_Meta.IHasOracleContent.html +++ b/docs/interfaces/Json_Meta.IHasOracleContent.html @@ -1,5 +1,5 @@ IHasOracleContent | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasOracleContent

Interface for items with metadata that describes an oracle's semantic or lexical content.

-

Hierarchy

  • IHasOracleContent

Index

Properties

Properties

+

Hierarchy

  • IHasOracleContent

Index

Properties

Properties

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

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasQuestStarter.html b/docs/interfaces/Json_Meta.IHasQuestStarter.html index d965cd587..04f97a541 100644 --- a/docs/interfaces/Json_Meta.IHasQuestStarter.html +++ b/docs/interfaces/Json_Meta.IHasQuestStarter.html @@ -1,3 +1,3 @@ -IHasQuestStarter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasQuestStarter

Hierarchy

Index

Properties

Properties

Quest Starter: string
+IHasQuestStarter | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasQuestStarter

Hierarchy

Index

Properties

Properties

Quest Starter: string

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

markdown

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasRequirements.html b/docs/interfaces/Json_Meta.IHasRequirements.html index abc92b000..810d6293d 100644 --- a/docs/interfaces/Json_Meta.IHasRequirements.html +++ b/docs/interfaces/Json_Meta.IHasRequirements.html @@ -1,5 +1,5 @@ IHasRequirements | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasRequirements

Interface for items that have prerequisites.

-

Hierarchy

  • IHasRequirements

Index

Properties

Properties

Requires: IRequirements
+

Hierarchy

  • IHasRequirements

Index

Properties

Properties

Requires: IRequirements

Prerequisites for this item.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasRollTemplate.html b/docs/interfaces/Json_Meta.IHasRollTemplate.html index faad68c27..ec61d5d08 100644 --- a/docs/interfaces/Json_Meta.IHasRollTemplate.html +++ b/docs/interfaces/Json_Meta.IHasRollTemplate.html @@ -1,5 +1,5 @@ IHasRollTemplate | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasRollTemplate

Interface for items that include roll string templates.

-

Hierarchy

  • IHasRollTemplate

Index

Properties

Properties

Roll template: IRollTemplate
+

Hierarchy

  • IHasRollTemplate

Index

Properties

Properties

Roll template: IRollTemplate

Describes the string values of this item that should be replaced with template strings and filled with the results of one or more oracle rolls.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasSource.html b/docs/interfaces/Json_Meta.IHasSource.html index db34d468e..bea2081f2 100644 --- a/docs/interfaces/Json_Meta.IHasSource.html +++ b/docs/interfaces/Json_Meta.IHasSource.html @@ -1,5 +1,5 @@ IHasSource | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasSubtable.html b/docs/interfaces/Json_Meta.IHasSubtable.html index 0657a6329..dfba83978 100644 --- a/docs/interfaces/Json_Meta.IHasSubtable.html +++ b/docs/interfaces/Json_Meta.IHasSubtable.html @@ -1,4 +1,4 @@ IHasSubtable | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for items that have a subtable-like object.

deprecated

Currently only used by setting truths. If you need to denote a subtable, use the Oracle rolls property to point to an IOracle in the Oracles property of this table's parent.

-

Hierarchy

  • IHasSubtable

Index

Properties

Properties

Subtable: IRow[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • IHasSubtable

Index

Properties

Properties

Subtable: IRow[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasSuggestions.html b/docs/interfaces/Json_Meta.IHasSuggestions.html index 123670656..9d66cc9e8 100644 --- a/docs/interfaces/Json_Meta.IHasSuggestions.html +++ b/docs/interfaces/Json_Meta.IHasSuggestions.html @@ -1,5 +1,5 @@ IHasSuggestions | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHasSuggestions

Interface for items that include "non-canonical" suggestions of related items.

-

Hierarchy

  • IHasSuggestions

Index

Properties

Properties

Suggestions: ISuggestions
+

Hierarchy

  • IHasSuggestions

Index

Properties

Properties

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.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasSummary.html b/docs/interfaces/Json_Meta.IHasSummary.html index 9a79f1b0c..5cef6e134 100644 --- a/docs/interfaces/Json_Meta.IHasSummary.html +++ b/docs/interfaces/Json_Meta.IHasSummary.html @@ -1,5 +1,5 @@ IHasSummary | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for items with a user-facing markdown summary.

-

Hierarchy

Index

Properties

Properties

Summary: string
+

Hierarchy

Index

Properties

Properties

Summary: string

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

markdown

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasTable.html b/docs/interfaces/Json_Meta.IHasTable.html index 98ca75838..7104bead2 100644 --- a/docs/interfaces/Json_Meta.IHasTable.html +++ b/docs/interfaces/Json_Meta.IHasTable.html @@ -1,3 +1,3 @@ IHasTable | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for items that have a table-like object.

-

Hierarchy

Index

Properties

Properties

Table: IRow[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Table: IRow[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasTags.html b/docs/interfaces/Json_Meta.IHasTags.html index e4ab97cc5..81ef66050 100644 --- a/docs/interfaces/Json_Meta.IHasTags.html +++ b/docs/interfaces/Json_Meta.IHasTags.html @@ -1,3 +1,3 @@ -IHasTags | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IHasTags

Index

Properties

Properties

Tags: string[]
+IHasTags | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IHasTags

Index

Properties

Properties

Tags: string[]

Arbitrary strings tags that describe optional metadata that doesn't fit in other properties.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IHasText.html b/docs/interfaces/Json_Meta.IHasText.html index a281d4fd3..ad0ae9bde 100644 --- a/docs/interfaces/Json_Meta.IHasText.html +++ b/docs/interfaces/Json_Meta.IHasText.html @@ -1,5 +1,5 @@ IHasText | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for items that reproduce Starforged rules text in markdown.

-

Hierarchy

Index

Properties

Properties

Text: string
+

Hierarchy

Index

Properties

Properties

Text: string

The item's rules text as a markdown string.

markdown

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.IRequirements.html b/docs/interfaces/Json_Meta.IRequirements.html index 369f4da8f..467bb210e 100644 --- a/docs/interfaces/Json_Meta.IRequirements.html +++ b/docs/interfaces/Json_Meta.IRequirements.html @@ -1,5 +1,5 @@ IRequirements | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IRequirements

Data describing an item's requirements.

-

Hierarchy

  • IRequirements

Index

Properties

Properties

Attributes: IAttributeChoices[]
+

Hierarchy

  • IRequirements

Index

Properties

Properties

Attributes: IAttributeChoices[]

A list of attribute keys, and values of those keys that satisfy the requirements.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.ISource.html b/docs/interfaces/Json_Meta.ISource.html index 8b039d133..988d313a9 100644 --- a/docs/interfaces/Json_Meta.ISource.html +++ b/docs/interfaces/Json_Meta.ISource.html @@ -1,19 +1,19 @@ ISource | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface representing data on this item's source. For 'canonical' content, this is usually a book with numbered pages, but it might also be a link to a web site.

-

Hierarchy

  • ISource

Index

Properties

Authors: string[]
+

Hierarchy

  • ISource

Index

Properties

Authors: string[]

The author(s) of this item. For 'canonical' content, this one's usually pretty obvious 😉 However, it's included so that homebrew content can use the same interface/schema.

default

["Shawn Tomkin"]

-
Date?: string
+
Date?: string

The 6-number date string formatted as MMDDYY. Relevant only during Starforged development; it will be deprecated once the game is released.

pattern

^(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])([0-9][0-9])$

-
Page?: number
+
Page?: number

The page on which the item appears most prominently in the source material (if it's in a format that uses page numbers).

-
Title: string
+
Title: string

The title of the source.

For 'canonical' content, use one of the enumerated SourceTitle strings.

For 3rd-party content (including homebrew) that's been released as part of a titled document, use the title of that document (e.g. "Steelforged", "Ironsmith").

If the source has no particular title (for instance, it's a single custom element in a VTT implementation), use "Custom".

-
Url?: string
+
Url?: string

The URL where the source material is available.

pattern

^https?://.*$

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Meta.ISuggestions.html b/docs/interfaces/Json_Meta.ISuggestions.html index 4bedd0dc4..27629af34 100644 --- a/docs/interfaces/Json_Meta.ISuggestions.html +++ b/docs/interfaces/Json_Meta.ISuggestions.html @@ -2,14 +2,14 @@

Describes "non-canonical" suggestions for game content related to the parent item.

These are intended be offered as convenient shortcuts for the user (for instance, including a menu dropdown for rolling on suggested tables); having them roll automatically is not recommended for most projects.

These can be safely ignored if that functionality is not desired.

-

Hierarchy

  • ISuggestions

Index

Properties

Assets?: string[]
+

Hierarchy

  • ISuggestions

Index

Properties

Assets?: string[]

Suggested asset IDs.

-
Encounters?: string[]
+
Encounters?: string[]

Suggested encounter IDs.

-
Game objects?: IGameObject[]
+
Game objects?: IGameObject[]

Suggested game objects and their parameters.

-
Moves?: string[]
+
Moves?: string[]

Suggested move IDs.

-
Oracle rolls?: string[]
+
Oracle rolls?: string[]

Suggested oracle rolls, by table ID. Multiples of the same ID can be used to indicate that multiple rolls should be made.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMove.html b/docs/interfaces/Json_Moves.IMove.html index 19ae83166..70d5a4928 100644 --- a/docs/interfaces/Json_Moves.IMove.html +++ b/docs/interfaces/Json_Moves.IMove.html @@ -1,32 +1,32 @@ IMove | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface representing a Starforged move.

-

Hierarchy

Index

Properties

$id: string
example

"Starforged/Moves/Adventure/Face_Danger"

+

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
+
Asset?: string

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

-
Category: string
+
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
+
Name: string
example

"Face Danger"

+
Optional: boolean

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

default

false

-
Oracles?: string[]
+
Oracles?: string[]

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

-
Outcomes?: IMoveOutcomes
+
Outcomes?: IMoveOutcomes

Outcome information for the move.

-
Progress Move?: boolean
+
Progress Move?: boolean

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

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Suggestions?: ISuggestions
+
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
+
Tags?: string[]
Text: string

The item's rules text as a markdown string.

-
markdown
Trigger: IMoveTrigger
+
markdown
Trigger: IMoveTrigger

The move's trigger data.

-
Variant of?: string
+
Variant of?: string

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

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMoveCategory.html b/docs/interfaces/Json_Moves.IMoveCategory.html index 7408881f7..dbba87d74 100644 --- a/docs/interfaces/Json_Moves.IMoveCategory.html +++ b/docs/interfaces/Json_Moves.IMoveCategory.html @@ -1,15 +1,15 @@ IMoveCategory | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a category of moves such as "Session Moves" or "Combat Moves", and serves as a container for moves within that category.

-

Hierarchy

Index

Properties

$id: string
example

"Starforged/Moves/Adventure"

+

Hierarchy

Index

Properties

$id: string
example

"Starforged/Moves/Adventure"

pattern

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

-
Description: string
+
Description: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Moves: IMove[]
Name: string
example

"Adventure"

-
Optional: boolean
+
Moves: IMove[]
Name: string
example

"Adventure"

+
Optional: boolean

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

default

false

-
Source: ISource
+
Source: ISource

Information on this item's source.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMoveOutcomes.html b/docs/interfaces/Json_Moves.IMoveOutcomes.html index a0ff636d6..1b82f6394 100644 --- a/docs/interfaces/Json_Moves.IMoveOutcomes.html +++ b/docs/interfaces/Json_Moves.IMoveOutcomes.html @@ -1,2 +1,2 @@ -IMoveOutcomes | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$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$

-
Strong Hit: IOutcomeInfo
Weak Hit: IOutcomeInfo

Generated using TypeDoc

\ No newline at end of file +IMoveOutcomes | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$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$

+
Strong Hit: IOutcomeInfo
Weak Hit: IOutcomeInfo

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMoveReroll.html b/docs/interfaces/Json_Moves.IMoveReroll.html index baf9d6964..fff9fd4f9 100644 --- a/docs/interfaces/Json_Moves.IMoveReroll.html +++ b/docs/interfaces/Json_Moves.IMoveReroll.html @@ -1,7 +1,7 @@ IMoveReroll | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes a reroll offered by a move outcome. The vast majority of rerolls in Ironsworn are elective, so automatic rerolling isn't recommended.

-

Hierarchy

Index

Properties

Properties

+

Hierarchy

Index

Properties

Properties

The dice to be rerolled.

-
Text: string
+
Text: string

The markdown string describing the conditions of the reroll. It should be presented to the user so that they can decide whether a reroll is appropriate.

markdown

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMoveTrigger.html b/docs/interfaces/Json_Moves.IMoveTrigger.html index e12fb5db8..f114d8532 100644 --- a/docs/interfaces/Json_Moves.IMoveTrigger.html +++ b/docs/interfaces/Json_Moves.IMoveTrigger.html @@ -1,13 +1,13 @@ IMoveTrigger | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the trigger conditions of the move.

-

Hierarchy

Index

Properties

$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_-]+)/Trigger$

-
+

Hierarchy

Index

Properties

$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_-]+)/Trigger$

+

Information on who can trigger this item. Used mainly by asset abilities, some of which can trigger from an Ally's move.

If unspecified, assume Ally is false and Player is true.

-
+

Information on any action rolls or progress rolls that are made when this move is triggered (which may describe a specific subset of the primary trigger in their own Text property).

If there's no action rolls or progress rolls attached to this move, this is undefined.

-
Text?: string
+
Text?: string

A markdown string containing the primary trigger text for this move.

Secondary triggers (for specific stats or uses of an asset ability) are described in Options.

markdown
example

"When you attempt something risky or react to an imminent threat..."

diff --git a/docs/interfaces/Json_Moves.IMoveTriggerBy.html b/docs/interfaces/Json_Moves.IMoveTriggerBy.html index 3625c0ae7..f0aae37b8 100644 --- a/docs/interfaces/Json_Moves.IMoveTriggerBy.html +++ b/docs/interfaces/Json_Moves.IMoveTriggerBy.html @@ -1,5 +1,5 @@ -IMoveTriggerBy | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IMoveTriggerBy

Index

Properties

Properties

Ally: boolean
+IMoveTriggerBy | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IMoveTriggerBy

Index

Properties

Properties

Ally: boolean

Whether an Ally (a player character other than the owner) can trigger this item. This is usually false, but there's several exceptions among asset abilities.

-
Player: boolean
+
Player: boolean

Whether the player character who owns this item can trigger it. Unsurprisingly, this is usually true, but there's a few exceptions: see Starforged's LOYALIST asset for an example.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMoveTriggerOptionAction.html b/docs/interfaces/Json_Moves.IMoveTriggerOptionAction.html index ee0c1f4d2..94a246093 100644 --- a/docs/interfaces/Json_Moves.IMoveTriggerOptionAction.html +++ b/docs/interfaces/Json_Moves.IMoveTriggerOptionAction.html @@ -1,12 +1,12 @@ -IMoveTriggerOptionAction | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMoveTriggerOptionAction

Hierarchy

Index

Properties

$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_-]+)/Trigger/Options/[0-9]+$

-
Custom stat?: ICustomStat
+IMoveTriggerOptionAction | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMoveTriggerOptionAction

Hierarchy

Index

Properties

$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_-]+)/Trigger/Options/[0-9]+$

+
Custom stat?: ICustomStat

Defines a custom stat, if one is included in this object's With array.

-
Method: RollMethod
+
Method: RollMethod

The method used to choose the stat or track in the Using array.

-
Roll type: Action
+
Roll type: Action

Whether this option is an action roll or progress roll.

-
Text?: string
+
Text?: string

The item's rules text as a markdown string.

-
markdown
Using: string[]
+
markdown
Using: string[]

The stat(s) or progress track(s) that may be rolled with this move trigger option.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMoveTriggerOptionBase.html b/docs/interfaces/Json_Moves.IMoveTriggerOptionBase.html index b2957b188..66f62a12e 100644 --- a/docs/interfaces/Json_Moves.IMoveTriggerOptionBase.html +++ b/docs/interfaces/Json_Moves.IMoveTriggerOptionBase.html @@ -1,12 +1,12 @@ -IMoveTriggerOptionBase | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMoveTriggerOptionBase

Hierarchy

Index

Properties

$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_-]+)/Trigger/Options/[0-9]+$

-
Custom stat?: ICustomStat
+IMoveTriggerOptionBase | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMoveTriggerOptionBase

Hierarchy

Index

Properties

$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_-]+)/Trigger/Options/[0-9]+$

+
Custom stat?: ICustomStat

Defines a custom stat, if one is included in this object's With array.

-
Method: RollMethod
+
Method: RollMethod

The method used to choose the stat or track in the Using array.

-
Roll type: RollType
+
Roll type: RollType

Whether this option is an action roll or progress roll.

-
Text?: string
+
Text?: string

The item's rules text as a markdown string.

-
markdown
Using: string[]
+
markdown
Using: string[]

The stat(s) or progress track(s) that may be rolled with this move trigger option.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IMoveTriggerOptionProgress.html b/docs/interfaces/Json_Moves.IMoveTriggerOptionProgress.html index ba29631e5..d0c771228 100644 --- a/docs/interfaces/Json_Moves.IMoveTriggerOptionProgress.html +++ b/docs/interfaces/Json_Moves.IMoveTriggerOptionProgress.html @@ -1,12 +1,12 @@ -IMoveTriggerOptionProgress | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMoveTriggerOptionProgress

Hierarchy

Index

Properties

$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_-]+)/Trigger/Options/[0-9]+$

-
Custom stat?: ICustomStat
+IMoveTriggerOptionProgress | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IMoveTriggerOptionProgress

Hierarchy

Index

Properties

$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_-]+)/Trigger/Options/[0-9]+$

+
Custom stat?: ICustomStat

Defines a custom stat, if one is included in this object's With array.

-
Method: RollMethod
+
Method: RollMethod

The method used to choose the stat or track in the Using array.

-
Roll type: Progress
+
Roll type: Progress

Whether this option is an action roll or progress roll.

-
Text?: string
+
Text?: string

The item's rules text as a markdown string.

-
markdown
+
markdown

The stat(s) or progress track(s) that may be rolled with this move trigger option.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Moves.IOutcomeInfo.html b/docs/interfaces/Json_Moves.IOutcomeInfo.html index f8d1dcb32..76d4d82f3 100644 --- a/docs/interfaces/Json_Moves.IOutcomeInfo.html +++ b/docs/interfaces/Json_Moves.IOutcomeInfo.html @@ -1,12 +1,12 @@ -IOutcomeInfo | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$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)$

-
Count as?: "Miss" | "Weak Hit" | "Strong Hit"
+IOutcomeInfo | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

$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)$

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

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

-
In Control?: boolean
+
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.

-
Reroll?: IMoveReroll
+
Reroll?: IMoveReroll

Information on rerolls offered by this move.

-
Text: string
+
Text: string

The item's rules text as a markdown string.

-
markdown
With a Match?: IOutcomeInfo
+
markdown
With a Match?: IOutcomeInfo

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

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IDisplayOracle.html b/docs/interfaces/Json_Oracles.IDisplayOracle.html index c556c1354..65fdacddc 100644 --- a/docs/interfaces/Json_Oracles.IDisplayOracle.html +++ b/docs/interfaces/Json_Oracles.IDisplayOracle.html @@ -1,23 +1,23 @@ IDisplayOracle | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Information on displaying Oracles, including their table(s) are rendered in the original text. Useful if you want your project's rendering of the tables to correspond with the book.

-

Hierarchy

Index

Properties

Color?: string
+

Hierarchy

Index

Properties

Color?: string

A hex color associated with this item, for use as e.g. an accent color in its display.

pattern

^#[A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9][A-f0-9]$

-
Column of?: string
+
Column of?: string

If this oracle's Table should be rendered as a column of another table, it's indicated here.

If undefined, this table is rendered as a standalone table.

If this is set (and the rendering such 'embedded' columns is desired), then Display.Table may be safely ignored.

-
Embed in?: null | string
+
Embed in?: null | string

This table is displayed as embedded in a row of another table.

-
Icon?: string
+
Icon?: string

A URL pointing to a single SVG icon.

pattern

^../../img/vector/[A-z-_0-9/]+.svg$

-
Images?: string[]
+
Images?: string[]

An array of URLs pointing to one or more WEBP images.

pattern

^../../img/raster/[A-z-_0-9/]+.webp$

-
+

Information on the rendering of this table when it's provided as a standalone table (as opposed to a column of another table).

If close correspondence to the text's table rendering is desired, Display["Column of"] should be preferred (when present).

-
Title: string
+
Title: string

The title of this item as it appears printed in the rulebook. Intended for use as the item's header, label, etc.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IMultipleRolls.html b/docs/interfaces/Json_Oracles.IMultipleRolls.html index 54414766d..bc9ce98ad 100644 --- a/docs/interfaces/Json_Oracles.IMultipleRolls.html +++ b/docs/interfaces/Json_Oracles.IMultipleRolls.html @@ -1,11 +1,11 @@ IMultipleRolls | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes IRow results that call for multiple rolls, most commonly "Roll twice" results.

-

Hierarchy

  • IMultipleRolls

Index

Properties

Allow duplicates: boolean
+

Hierarchy

  • IMultipleRolls

Index

Properties

Allow duplicates: boolean

Whether to allow duplicate results when generating multiple rolls.

Implicitly required by Make it worse.

-
Amount: number
+
Amount: number

The number of rolls to make on the parent oracle table.

-
Make it worse: boolean
+
Make it worse: boolean

Whether duplicate rolls should be compounded in an Ironsworn-style "Make it worse" results.

Typically this is accompanied by IRow.Result text like "Roll twice more on this table. Both results occur. If they are the same result, make it worse."

Can safely be ignored in Starforged-only implementations. Implicitly requires Allow duplicates.

diff --git a/docs/interfaces/Json_Oracles.IOracle.html b/docs/interfaces/Json_Oracles.IOracle.html index c71755926..24ad49c71 100644 --- a/docs/interfaces/Json_Oracles.IOracle.html +++ b/docs/interfaces/Json_Oracles.IOracle.html @@ -1,30 +1,30 @@ IOracle | Dataforged API
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[]
+

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
+
Category: string

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

-
Content?: IOracleContent
+
Content?: IOracleContent

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

-
Description?: string
+
Description?: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Member of?: string
+
Member of?: string

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

-
Name: 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.

-
Oracles?: IOracle[]
+
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
+
Source: ISource

Information on this item's source.

-
Table?: IRow[]
+
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
+
Usage?: IOracleUsage

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

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IOracleBase.html b/docs/interfaces/Json_Oracles.IOracleBase.html index ea9ff39b6..36c677e0d 100644 --- a/docs/interfaces/Json_Oracles.IOracleBase.html +++ b/docs/interfaces/Json_Oracles.IOracleBase.html @@ -2,37 +2,37 @@

Interface with elements common to various Oracle-related interfaces and classes.

If you're trying to crawl the tree for a specific ID, I'd recommend using some flavour of JSONpath (I like jsonpath-plus) - it's purpose-made for this sort of nested data structure.

But if for some reason you can't, you can use this interface to type both IOracle and IOracleCategory as you recurse the oracle hierarchy. Objects with Categories and Oracles are "branches", and objects with Table are "leaves".

-

Hierarchy

Index

Properties

$id: string
+

Hierarchy

Index

Properties

$id: string

The item's unique string ID.

pattern

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

-
Aliases?: string[]
+
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.

-
Categories?: IOracleCategory[]
+
Categories?: IOracleCategory[]

Subcategories contained by this oracle category.

This key appears only on IOracleCategory, and thus only on 'branch' nodes of the oracle hierarchy 'tree.

-
Category?: string
+
Category?: string

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

pattern

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

-
Content?: IOracleContent
+
Content?: IOracleContent

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

-
Description?: string
+
Description?: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Member of?: string
+
Member of?: string

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

pattern

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

-
Name: 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.

-
Oracles?: IOracle[]
+
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
+
Source: ISource

Information on this item's source.

-
Table?: IRow[]
+
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
+
Usage?: IOracleUsage

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

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IOracleCategory.html b/docs/interfaces/Json_Oracles.IOracleCategory.html index 2625577c7..6da27d9e2 100644 --- a/docs/interfaces/Json_Oracles.IOracleCategory.html +++ b/docs/interfaces/Json_Oracles.IOracleCategory.html @@ -1,31 +1,31 @@ IOracleCategory | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents an oracle category: a grouping that can contain both IOracles and other instances of IOracleCategory, but doesn't have its own Table key.

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[]
+

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.

-
Categories?: IOracleCategory[]
+
Categories?: IOracleCategory[]

Subcategories contained by this oracle category.

This key appears only on IOracleCategory, and thus only on 'branch' nodes of the oracle hierarchy 'tree.

-
Category?: string
Content?: IOracleContent
+
Category?: string
Content?: IOracleContent

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

-
Description?: string
+
Description?: string

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

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Member of?: string
+
Member of?: string

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

pattern

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

-
Name: 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.

-
Oracles?: IOracle[]
+
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).

-
Sample Names?: string[]
+
Sample Names?: string[]

A list of sample names for this category (only used by Planetary Class subcategories).

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Usage?: IOracleUsage
+
Usage?: IOracleUsage

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

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IOracleContent.html b/docs/interfaces/Json_Oracles.IOracleContent.html index f8c96a612..376bfd1bd 100644 --- a/docs/interfaces/Json_Oracles.IOracleContent.html +++ b/docs/interfaces/Json_Oracles.IOracleContent.html @@ -1,7 +1,7 @@ IOracleContent | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for metadata that describes an oracle's semantic or lexical content.

-

Hierarchy

  • IOracleContent

Index

Properties

Part of speech?: PartOfSpeechTag[]
+

Hierarchy

  • IOracleContent

Index

Properties

Part of speech?: PartOfSpeechTag[]

The part of speech of this oracle.

-
Tags?: string[]
+
Tags?: string[]

Any arbitrary string tags associated with this oracle.

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IOracleUsage.html b/docs/interfaces/Json_Oracles.IOracleUsage.html index ef2b12c66..59553e2cb 100644 --- a/docs/interfaces/Json_Oracles.IOracleUsage.html +++ b/docs/interfaces/Json_Oracles.IOracleUsage.html @@ -1,21 +1,21 @@ IOracleUsage | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the recommended usage of this item.

-

Hierarchy

Index

Properties

Allow duplicates?: boolean
+

Hierarchy

Index

Properties

Allow duplicates?: boolean

Whether multiple rolls (as in object generation, or with IMultipleRolls) .

-
Initial?: boolean
+
Initial?: boolean

Whether this table should be included in the initial oracle rolls when generating a game object. This is a somewhat arbitrary recommendation, and may not be appropriate for all implementations (or all game situations). Rather it's a reasonable starting point in most cases.

That said, the game itself recommends against rolling all possible results at once (see "Peeling the Onion", p. 293, Starforged). If your goal is to implement the game 'as-written', consider how you might include some means of "progressive disclosure" of oracle results.

May be deprecated in the future in favour of dedicated object template information.

-
Max rolls?: number
+
Max rolls?: number

The maximum number of rolls when using this oracle to create a game object. Assume it's 1 if not specified.

-
Min rolls?: number
+
Min rolls?: number

The minimum number of rolls when using this oracle to create a game object, if this oracle is rolled. Assume it's 1 if not specified.

deprecated

Previous versions of the Starforged Backer Preview had tables that made use of this key, but none do at present. Given the "peeling the onion" philosophy, this key is of limited utility, and will probably be removed in future versions.

-
Repeatable?: boolean
+
Repeatable?: boolean

Whether the table's standard use is iterative. Common examples are Feature, Opportunity, and Peril tables, which are most often used repeatedly to describe different areas of/events in a place, rather than being assigned as a description of the place as a whole.

Mutually exclusive with Max rolls. If undefined, assume false.

-
Requires?: IRequirements
Roll template?: IRollTemplate
+
Requires?: IRequirements
Roll template?: IRollTemplate

Describes the string values of this item that should be replaced with template strings and filled with the results of one or more oracle rolls.

-
+

Hints which attributes are set by this table.

-
Suggestions?: ISuggestions

Generated using TypeDoc

\ No newline at end of file +
Suggestions?: ISuggestions

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IRollColumn.html b/docs/interfaces/Json_Oracles.IRollColumn.html index 1586ef10c..485f49cfd 100644 --- a/docs/interfaces/Json_Oracles.IRollColumn.html +++ b/docs/interfaces/Json_Oracles.IRollColumn.html @@ -1,3 +1,3 @@ -IRollColumn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Label: string
Use content from: string
+IRollColumn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IRollTemplate.html b/docs/interfaces/Json_Oracles.IRollTemplate.html index 629563434..1d810933f 100644 --- a/docs/interfaces/Json_Oracles.IRollTemplate.html +++ b/docs/interfaces/Json_Oracles.IRollTemplate.html @@ -1,9 +1,9 @@ IRollTemplate | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the string keys of this item that should be replaced with template strings and filled with the results of one or more oracles.

-

Hierarchy

  • IRollTemplate

Index

Properties

Description?: string
+

Hierarchy

  • IRollTemplate

Index

Properties

Description?: string

A template string for the parent's Description property, to be filled with an oracle table roll Result.

-
Result?: string
+
Result?: string

A template string for the parent's Result property, to be filled with an oracle table roll Result.

-
Summary?: string
+
Summary?: string

A template string for the parent's Summary property, to be filled with an oracle table roll Result.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.IRow.html b/docs/interfaces/Json_Oracles.IRow.html index 716937fd8..72ed3cdac 100644 --- a/docs/interfaces/Json_Oracles.IRow.html +++ b/docs/interfaces/Json_Oracles.IRow.html @@ -1,39 +1,39 @@ IRow | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface representing a single row in an oracle table.

-

Hierarchy

Index

Properties

$id?: null | string
+

Hierarchy

Index

Properties

$id?: null | string

The ID of this row.

pattern

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

-
nullable
Attributes?: IAttribute[]
+
nullable
Attributes?: IAttribute[]

The attributes set by this row.

-
Ceiling: null | number
+
Ceiling: null | number

The high end of the dice range for this row.

minimum

1

maximum

100

-
nullable
Content?: IOracleContent
+
nullable
Content?: IOracleContent

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

-
Display?: IDisplay
+
Display?: IDisplay

Data relevant to this item's display/rendering.

-
Floor: null | number
+
Floor: null | number

The low end of the dice range for this row.

minimum

1

maximum

100

-
nullable
Game objects?: IGameObject[]
+
nullable
Game objects?: IGameObject[]

Any game objects that are explicitly pointed to by the original text. For most implementations, it is not recommended to generate them automatically - see "Peeling the Onion", p. 293.

-
Multiple rolls?: IMultipleRolls
+
Multiple rolls?: IMultipleRolls

Data for rows that call for multiple rolls, e.g. on Roll twice results.

-
Oracle rolls?: string[]
+
Oracle rolls?: string[]

Additional oracle tables that should be rolled when this row is selected.

-
Result: string
+
Result: string

The primary result text for the row, annotated in Markdown. In the book, this is frequently the only column aside from the roll column. Otherwise, it is the first column. Some tables label this column as something other than Result; see the parent (or grandparent) Oracle.Display for more information.

-
Roll template?: IRollTemplate
+
Roll template?: IRollTemplate

Describes the string values of this item that should be replaced with template strings and filled with the results of one or more oracle rolls.

-
Subtable?: IRow[]
+
Subtable?: IRow[]

A table to be rolled when this row is selected. If this row references an external oracle, the Oracles property is used instead.

-
Suggestions?: ISuggestions
+
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.

-
Summary?: null | string
+
Summary?: null | string

A secondary markdown string that must be presented to the user for the implementation to be complete, but may benefit from progressive disclosure (such as a collapsible element, popover/tooltip, etc).

Generally, Summary is longer than Result.

Some tables label this column as something other than Result; see the parent (or grandparent) IOracle.Display.Table for more information.

diff --git a/docs/interfaces/Json_Oracles.ITableColumnBase.html b/docs/interfaces/Json_Oracles.ITableColumnBase.html index 01800d273..6f1314e1e 100644 --- a/docs/interfaces/Json_Oracles.ITableColumnBase.html +++ b/docs/interfaces/Json_Oracles.ITableColumnBase.html @@ -1,5 +1,5 @@ ITableColumnBase | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface with elements common to IRollColumn and ITextColumn.

-

Hierarchy

Index

Properties

Label: string
Use content from: string
+

Hierarchy

Index

Properties

Label: string
Use content from: string

The ID of the oracle table to use.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.ITableDisplayInfo.html b/docs/interfaces/Json_Oracles.ITableDisplayInfo.html index cf04fb0eb..6555bff51 100644 --- a/docs/interfaces/Json_Oracles.ITableDisplayInfo.html +++ b/docs/interfaces/Json_Oracles.ITableDisplayInfo.html @@ -1,3 +1,3 @@ ITableDisplayInfo | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides information on how a specific oracle table is rendered in the source text.

-

Hierarchy

  • ITableDisplayInfo

Index

Properties

Result columns: ITextColumn[]
Roll columns: ITableColumnBase[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

  • ITableDisplayInfo

Index

Properties

Result columns: ITextColumn[]
Roll columns: ITableColumnBase[]

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_Oracles.ITextColumn.html b/docs/interfaces/Json_Oracles.ITextColumn.html index b5762e8ec..593ce9795 100644 --- a/docs/interfaces/Json_Oracles.ITextColumn.html +++ b/docs/interfaces/Json_Oracles.ITextColumn.html @@ -1,9 +1,9 @@ ITextColumn | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes the rendering of a table column that displays textual content (as opposed to IRollColumn, which displays numerical ranges).

-

Hierarchy

Index

Properties

Key: "Summary" | "Result"
+

Hierarchy

Index

Properties

Key: "Summary" | "Result"

The key of each Row in the Table, whose string value is displayed in the rendered table.

-
Label: string
+
Label: string

The label or header text to use for this column.

-
Use content from: string
+
Use content from: string

The ID of the oracle with a Table key.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_SettingTruths.ISettingTruth.html b/docs/interfaces/Json_SettingTruths.ISettingTruth.html index ac9d041ae..b082c7d6c 100644 --- a/docs/interfaces/Json_SettingTruths.ISettingTruth.html +++ b/docs/interfaces/Json_SettingTruths.ISettingTruth.html @@ -1,18 +1,18 @@ ISettingTruth | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for Setting Truth categories such as "Exodus" and "Cataclysm". See page XX of Starforged for further information.

see

ISettingTruthOption

-

Hierarchy

Index

Properties

$id: string
pattern

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

-
Character: string
+

Hierarchy

Index

Properties

$id: string
pattern

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

+
Character: string

A Markdown version of the text that appears at the end of each Truth entry; it offers suggestions on the character's assets and background.

-
markdown
+
markdown

Data relevant to this item's display/rendering.

-
Name: 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.

-
Source: ISource
+
Source: ISource

Information on this item's source.

-
Suggestions?: ISuggestions
+
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.

-
+

The 'canonical' options for this setting truth category.

Legend

  • Type alias
  • Type alias with type parameter
  • Interface
  • Property
  • Enumeration

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/Json_SettingTruths.ISettingTruthOption.html b/docs/interfaces/Json_SettingTruths.ISettingTruthOption.html index 910de047f..c08d9503d 100644 --- a/docs/interfaces/Json_SettingTruths.ISettingTruthOption.html +++ b/docs/interfaces/Json_SettingTruths.ISettingTruthOption.html @@ -1,42 +1,42 @@ ISettingTruthOption | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface for 'canonical' options within a SettingTruth category.

see

ISettingTruth

-

Hierarchy

Index

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Setting_Truths/[A-z_-]+/(1-33|34-67|68-100|[1-3])$

-
Attributes?: IAttribute[]
+

Hierarchy

Index

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Setting_Truths/[A-z_-]+/(1-33|34-67|68-100|[1-3])$

+
Attributes?: IAttribute[]

The attributes set by this row.

-
Ceiling: null | number
+
Ceiling: null | number

The high end of the dice range for this row.

minimum

1

maximum

100

-
nullable
Content?: IOracleContent
+
nullable
Content?: IOracleContent

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

-
Description: string
+
Description: string

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

-
markdown
Display?: IDisplay
+
markdown
Display?: IDisplay

Data relevant to this item's display/rendering.

-
Floor: null | number
+
Floor: null | number

The low end of the dice range for this row.

minimum

1

maximum

100

-
nullable
Game objects?: IGameObject[]
+
nullable
Game objects?: IGameObject[]

Any game objects that are explicitly pointed to by the original text. For most implementations, it is not recommended to generate them automatically - see "Peeling the Onion", p. 293.

-
Multiple rolls?: IMultipleRolls
+
Multiple rolls?: IMultipleRolls

Data for rows that call for multiple rolls, e.g. on Roll twice results.

-
Oracle rolls?: string[]
+
Oracle rolls?: string[]

Additional oracle tables that should be rolled when this row is selected.

-
Quest Starter: string
+
Quest Starter: string

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

-
markdown
Result: string
+
markdown
Result: string

The primary result text for the row, annotated in Markdown. In the book, this is frequently the only column aside from the roll column. Otherwise, it is the first column. Some tables label this column as something other than Result; see the parent (or grandparent) Oracle.Display for more information.

-
Roll template?: IRollTemplate
+
Roll template?: IRollTemplate

Describes the string values of this item that should be replaced with template strings and filled with the results of one or more oracle rolls.

-
Subtable?: IRow[]
+
Subtable?: IRow[]

A table to be rolled when this row is selected. If this row references an external oracle, the Oracles property is used instead.

-
Suggestions?: ISuggestions
+
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.

-
Summary?: null | string
+
Summary?: null | string

A secondary markdown string that must be presented to the user for the implementation to be complete, but may benefit from progressive disclosure (such as a collapsible element, popover/tooltip, etc).

Generally, Summary is longer than Result.

Some tables label this column as something other than Result; see the parent (or grandparent) IOracle.Display.Table for more information.

diff --git a/docs/interfaces/Json_SettingTruths.ISettingTruthOptionSubtableRow.html b/docs/interfaces/Json_SettingTruths.ISettingTruthOptionSubtableRow.html index 0b26f40dd..d043570bd 100644 --- a/docs/interfaces/Json_SettingTruths.ISettingTruthOptionSubtableRow.html +++ b/docs/interfaces/Json_SettingTruths.ISettingTruthOptionSubtableRow.html @@ -1,35 +1,35 @@ -ISettingTruthOptionSubtableRow | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IRow
    • ISettingTruthOptionSubtableRow

Index

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Setting_Truths/[A-z_-]+/(1-33|34-67|68-100|[1-3])/[1-9][0-9](-[1-9][0-9])?$

-
Attributes?: IAttribute[]
+ISettingTruthOptionSubtableRow | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IRow
    • ISettingTruthOptionSubtableRow

Index

Properties

$id: string
pattern

^(Starforged|Ironsworn)/Setting_Truths/[A-z_-]+/(1-33|34-67|68-100|[1-3])/[1-9][0-9](-[1-9][0-9])?$

+
Attributes?: IAttribute[]

The attributes set by this row.

-
Ceiling: null | number
+
Ceiling: null | number

The high end of the dice range for this row.

minimum

1

maximum

100

-
nullable
Content?: IOracleContent
+
nullable
Content?: IOracleContent

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

-
Display?: IDisplay
+
Display?: IDisplay

Data relevant to this item's display/rendering.

-
Floor: null | number
+
Floor: null | number

The low end of the dice range for this row.

minimum

1

maximum

100

-
nullable
Game objects?: IGameObject[]
+
nullable
Game objects?: IGameObject[]

Any game objects that are explicitly pointed to by the original text. For most implementations, it is not recommended to generate them automatically - see "Peeling the Onion", p. 293.

-
Multiple rolls?: IMultipleRolls
+
Multiple rolls?: IMultipleRolls

Data for rows that call for multiple rolls, e.g. on Roll twice results.

-
Oracle rolls?: string[]
+
Oracle rolls?: string[]

Additional oracle tables that should be rolled when this row is selected.

-
Result: string
+
Result: string

The primary result text for the row, annotated in Markdown. In the book, this is frequently the only column aside from the roll column. Otherwise, it is the first column. Some tables label this column as something other than Result; see the parent (or grandparent) Oracle.Display for more information.

-
Roll template?: IRollTemplate
+
Roll template?: IRollTemplate

Describes the string values of this item that should be replaced with template strings and filled with the results of one or more oracle rolls.

-
Subtable?: IRow[]
+
Subtable?: IRow[]

A table to be rolled when this row is selected. If this row references an external oracle, the Oracles property is used instead.

-
Suggestions?: ISuggestions
+
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.

-
Summary?: null | string
+
Summary?: null | string

A secondary markdown string that must be presented to the user for the implementation to be complete, but may benefit from progressive disclosure (such as a collapsible element, popover/tooltip, etc).

Generally, Summary is longer than Result.

Some tables label this column as something other than Result; see the parent (or grandparent) IOracle.Display.Table for more information.

diff --git a/docs/modules/Json_Assets.html b/docs/modules/Json_Assets.html index f19fb725e..eaa03a559 100644 --- a/docs/modules/Json_Assets.html +++ b/docs/modules/Json_Assets.html @@ -1,5 +1,5 @@ Json.Assets | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Json.Assets

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/Json_Common.html b/docs/modules/Json_Common.html index a9516fac7..ab8d3fe97 100644 --- a/docs/modules/Json_Common.html +++ b/docs/modules/Json_Common.html @@ -1,5 +1,5 @@ Json.Common | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Json.Common

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/Json_GameObjects.html b/docs/modules/Json_GameObjects.html index 1bf47e636..37b53d46a 100644 --- a/docs/modules/Json_GameObjects.html +++ b/docs/modules/Json_GameObjects.html @@ -1 +1 @@ -Json.GameObjects | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Json.GameObjects

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +Json.GameObjects | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Json.GameObjects

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/Json_Oracles.html b/docs/modules/Json_Oracles.html index e8ee02cc3..f141912a0 100644 --- a/docs/modules/Json_Oracles.html +++ b/docs/modules/Json_Oracles.html @@ -1 +1 @@ -Json.Oracles | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Json.Oracles

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +Json.Oracles | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Json.Oracles

Legend

  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Interface

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/tsconfig-cjs.json b/tsconfig-cjs.json index 33067296b..770f1ef4a 100644 --- a/tsconfig-cjs.json +++ b/tsconfig-cjs.json @@ -3,7 +3,7 @@ "extends": "./tsconfig.json", "exclude": [ "./src/**/*.d.ts", - "./src/index-esm.ts", + "./src/index-esm.ts" ], "include": [ "./src/**/*"