From d08963264f32f799793da843eedc69848f6ee91a Mon Sep 17 00:00:00 2001 From: rsek Date: Sun, 10 Jul 2022 03:17:57 -0700 Subject: [PATCH] rebuild docs with right version this time --- README.md | 2 +- 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 | 2 +- .../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 +- 150 files changed, 501 insertions(+), 501 deletions(-) diff --git a/README.md b/README.md index 3a25a135c..5ab3a3ea4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

Dataforged v1.3.2

+

Dataforged v1.4.0

undefined undefined diff --git a/docs/enums/Json_Assets.AssetTypeName.html b/docs/enums/Json_Assets.AssetTypeName.html index abaf0dbfe..c2d624fbd 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

Enumeration Members

CommandVehicle

CommandVehicle: "Command Vehicle"

Companion

Companion: "Companion"

Deed

Deed: "Deed"

Module

Module: "Module"

Path

Path: "Path"

SupportVehicle

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

Enumeration Members

CommandVehicle

CommandVehicle: "Command Vehicle"

Companion

Companion: "Companion"

Deed

Deed: "Deed"

Module

Module: "Module"

Path

Path: "Path"

SupportVehicle

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 e6666d87f..2ec88e843 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

Enumeration Members

ConditionMeter

ConditionMeter: "Condition Meter"
+

Index

Enumeration Members

Enumeration Members

ConditionMeter

ConditionMeter: "Condition Meter"

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

see

PlayerConditionMeter

-

Number

Number: "Number"
+

Number

Number: "Number"

A arbitrary pre-set number value.

-

Stat

Stat: "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

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 1de2711e4..4f101b139 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

Enumerates challenge ranks.

page

39

-

Index

Enumeration Members

Enumeration Members

Dangerous

Dangerous: 2

Epic

Epic: 5

Extreme

Extreme: 4

Formidable

Formidable: 3

Troublesome

Troublesome: 1

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Dangerous

Dangerous: 2

Epic

Epic: 5

Extreme

Extreme: 4

Formidable

Formidable: 3

Troublesome

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 393d961b2..68a71e509 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

Index

Enumeration Members

Enumeration Members

Eight

Eight: 8

Four

Four: 4

Six

Six: 6

Ten

Ten: 10

Generated using TypeDoc

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

Enumeration ClockSegments

Index

Enumeration Members

Enumeration Members

Eight

Eight: 8

Four

Four: 4

Six

Six: 6

Ten

Ten: 10

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 85b620977..3a747abd5 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

Enumeration ClockType

See clocks (p. 234) for more information.

-

Index

Enumeration Members

Enumeration Members

Campaign

Campaign: "Campaign"

Tension

Tension: "Tension"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Campaign

Campaign: "Campaign"

Tension

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 fefd24d92..40744349f 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

Enumeration Gamespace

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: "Ironsworn"

Starforged

Starforged: "Starforged"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Ironsworn

Ironsworn: "Ironsworn"

Starforged

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 15abdf834..48029efdb 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

Enumeration InputType

Index

Enumeration Members

Enumeration Members

Clock

Clock: "Clock"
see

IInputClock

-

Number

Number: "Number"
see

IInputNumber

-

Select

Select: "Select"
see

IInputSelect

-

Text

Text: "Text"
see

IInputText

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

Enumeration InputType

Index

Enumeration Members

Enumeration Members

Clock

Clock: "Clock"
see

IInputClock

+

Number

Number: "Number"
see

IInputNumber

+

Select

Select: "Select"
see

IInputSelect

+

Text

Text: "Text"
see

IInputText

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 542a32338..dbc49eff2 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

Enumeration MeterAlias

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

Enumeration Members

CommandVehicleIntegrity

CommandVehicleIntegrity: "Command Vehicle Integrity"

CompanionHealth

CompanionHealth: "Companion Health"

IncidentalVehicleIntegrity

IncidentalVehicleIntegrity: "Incidental Vehicle Integrity"

SupportVehicleIntegrity

SupportVehicleIntegrity: "Support Vehicle Integrity"

VehicleIntegrity

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

Enumeration Members

CommandVehicleIntegrity

CommandVehicleIntegrity: "Command Vehicle Integrity"

CompanionHealth

CompanionHealth: "Companion Health"

IncidentalVehicleIntegrity

IncidentalVehicleIntegrity: "Incidental Vehicle Integrity"

SupportVehicleIntegrity

SupportVehicleIntegrity: "Support Vehicle Integrity"

VehicleIntegrity

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 2abb09577..c6a7c3e21 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

Enumeration Members

Battered

Battered: "Battered"
+

Index

Enumeration Members

Enumeration Members

Battered

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: "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

OutOfAction: "Out of Action"
+

OutOfAction

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

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 3a38a627a..9fc58f6df 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

Enumeration MeterType

Enumerates player character resource meters.

-

Index

Enumeration Members

Enumeration Members

Health

Health: "Health"

Momentum

Momentum: "Momentum"

Spirit

Spirit: "Spirit"

Supply

Supply: "Supply"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Health

Health: "Health"

Momentum

Momentum: "Momentum"

Spirit

Spirit: "Spirit"

Supply

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 0b0e9e821..68e449a77 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: "Health"

Spirit

Spirit: "Spirit"

Supply

Supply: "Supply"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Health

Health: "Health"

Spirit

Spirit: "Spirit"

Supply

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 8b53d2b8a..91ee6f579 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

Index

Enumeration Members

Enumeration Members

Bonds

Bonds: "Bonds"

Combat

Combat: "Combat"

Delve

Delve: "Delve"

Journey

Journey: "Journey"

SceneChallenge

SceneChallenge: "Scene Challenge"

Vow

Vow: "Vow"

Generated using TypeDoc

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

Enumeration ProgressTypeIronsworn

Index

Enumeration Members

Enumeration Members

Bonds

Bonds: "Bonds"

Combat

Combat: "Combat"

Delve

Delve: "Delve"

Journey

Journey: "Journey"

SceneChallenge

SceneChallenge: "Scene Challenge"

Vow

Vow: "Vow"

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 06770befe..28168d9f8 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

Enumeration Members

Bonds

Bonds: "Bonds Legacy"

Combat

Combat: "Combat"

Connection

Connection: "Connection"

Discoveries

Discoveries: "Discoveries Legacy"

Expedition

Expedition: "Expedition"

Quests

Quests: "Quests Legacy"

SceneChallenge

SceneChallenge: "Scene Challenge"

Vow

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

Enumeration Members

Bonds

Bonds: "Bonds Legacy"

Combat

Combat: "Combat"

Connection

Connection: "Connection"

Discoveries

Discoveries: "Discoveries Legacy"

Expedition

Expedition: "Expedition"

Quests

Quests: "Quests Legacy"

SceneChallenge

SceneChallenge: "Scene Challenge"

Vow

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 cdd20ed8a..7b103e19e 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

Enumeration Members

Asset

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

Index

Enumeration Members

Enumeration Members

Asset

Asset: "${{@ASSET}}"

Replace with the ID of the nearest ancestor asset.

-

AssetMeter

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

AssetMeter

AssetMeter: "${{@ASSET_METER}}"

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

-

AssetSelectMeter

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

AssetSelectMeter

AssetSelectMeter: "${{@ASSET_SELECT_METER}}"

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

-

AssetSelectStat

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

AssetSelectStat

AssetSelectStat: "${{@ASSET_SELECT_STAT}}"

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

-

CustomStat

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

CustomStat

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 64566340f..c6e30ba7c 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

Enumeration Stat

Enumerates player character stats.

-

Index

Enumeration Members

Enumeration Members

Edge

Edge: "Edge"

Heart

Heart: "Heart"

Iron

Iron: "Iron"

Shadow

Shadow: "Shadow"

Wits

Wits: "Wits"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Edge

Edge: "Edge"

Heart

Heart: "Heart"

Iron

Iron: "Iron"

Shadow

Shadow: "Shadow"

Wits

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 eda76edf0..42f52e68e 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

Index

Enumeration Members

Enumeration Members

Animal

Animal: "Animal"

Anomaly

Anomaly: "Anomaly"

Beast

Beast: "Beast"

Firstborn

Firstborn: "Firstborn"

Horror

Horror: "Horror"

Ironlander

Ironlander: "Ironlander"

Generated using TypeDoc

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

Enumeration EncounterNatureIronsworn

Index

Enumeration Members

Enumeration Members

Animal

Animal: "Animal"

Anomaly

Anomaly: "Anomaly"

Beast

Beast: "Beast"

Firstborn

Firstborn: "Firstborn"

Horror

Horror: "Horror"

Ironlander

Ironlander: "Ironlander"

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 074b68f45..657685231 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

Index

Enumeration Members

Enumeration Members

Creature

Creature: "Creature"

Horror

Horror: "Horror"

Human

Human: "Human"

Machine

Machine: "Machine"

Monster

Monster: "Monster"

Generated using TypeDoc

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

Enumeration EncounterNatureStarforged

Index

Enumeration Members

Enumeration Members

Creature

Creature: "Creature"

Horror

Horror: "Horror"

Human

Human: "Human"

Machine

Machine: "Machine"

Monster

Monster: "Monster"

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 9f5a6dce1..54b6a0748 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

Enumeration EncounterTags

Index

Enumeration Members

Enumeration Members

Vehicle

Vehicle: "vehicle"

Generated using TypeDoc

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

Enumeration EncounterTags

Index

Enumeration Members

Enumeration Members

Vehicle

Vehicle: "vehicle"

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 8eb72ed83..b75677337 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

Enumeration Atmosphere

Set by Oracles / Planets / * / Atmosphere

-
alpha

Index

Enumeration Members

Enumeration Members

Breathable

Breathable: "Breathable"

Corrosive

Corrosive: "Corrosive"

Ideal

Ideal: "Ideal"

Marginal

Marginal: "Marginal"

NoneThin

NoneThin: "None / Thin"

Toxic

Toxic: "Toxic"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Breathable

Breathable: "Breathable"

Corrosive

Corrosive: "Corrosive"

Ideal

Ideal: "Ideal"

Marginal

Marginal: "Marginal"

NoneThin

NoneThin: "None / Thin"

Toxic

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 b4355a009..160647d3d 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

Enumeration AttributeKey

Index

Enumeration Members

Enumeration Members

Atmosphere

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

Enumeration AttributeKey

Index

Enumeration Members

Enumeration Members

Atmosphere

Atmosphere: "Atmosphere"

Atmosphere

-

Authority

Authority: "Authority"
+

Authority

Authority: "Authority"

Authority

-

Behavior

Behavior: "Encountered Behavior"
+

Behavior

Behavior: "Encountered Behavior"

Behavior

-

CreatureScale

CreatureScale: "Creature Scale"
+

CreatureScale

CreatureScale: "Creature Scale"

CreatureScale

-

DerelictType

DerelictType: "Derelict Type"
+

DerelictType

DerelictType: "Derelict Type"

DerelictType

-

Disposition

Disposition: "Disposition"
+

Disposition

Disposition: "Disposition"

Disposition

-

Dominion

Dominion: "Dominion"
+

Dominion

Dominion: "Dominion"

Dominion

-

Environment

Environment: "Environment"
+

Environment

Environment: "Environment"

Environment

-

FactionType

FactionType: "Faction Type"
+

FactionType

FactionType: "Faction Type"

FactionType

-

FringeGroup

FringeGroup: "Fringe Group"
+

FringeGroup

FringeGroup: "Fringe Group"

FringeGroup

-

Guild

Guild: "Guild"
+

Guild

Guild: "Guild"

Guild

-

Influence

Influence: "Influence"
+

Influence

Influence: "Influence"

Influence

-

InitialContact

InitialContact: "Initial Contact"
+

InitialContact

InitialContact: "Initial Contact"

StarshipInitialContact SettlementInitialContact

-

Leadership

Leadership: "Leadership"
+

Leadership

Leadership: "Leadership"

Leadership

-

Life

Life: "Life"
+

Life

Life: "Life"

Life

-

Location

Location: "Location"
+

Location

Location: "Location"

Location

-

LocationTheme

LocationTheme: "Location Theme"
+

LocationTheme

LocationTheme: "Location Theme"

LocationTheme

-

PlanetaryClass

PlanetaryClass: "Planetary Class"
+

PlanetaryClass

PlanetaryClass: "Planetary Class"

PlanetaryClass

-

Population

Population: "Population"
+

Population

Population: "Population"

Population

-

Region

Region: "Region"
+

Region

Region: "Region"

Region

-

Role

Role: "Role"
+

Role

Role: "Role"

Role

-

Zone

Zone: "Zone"
+

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 43809b140..675962884 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

Enumeration Authority

Set by Oracles / Settlements / Authority

-
alpha

Index

Enumeration Members

Enumeration Members

Corrupt

Corrupt: "Corrupt"

Fair

Fair: "Fair"

Ineffectual

Ineffectual: "Ineffectual"

NoneLawless

NoneLawless: "None / lawless"

Oppressive

Oppressive: "Oppressive"

Tolerant

Tolerant: "Tolerant"

Unyielding

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

Enumeration Members

Corrupt

Corrupt: "Corrupt"

Fair

Fair: "Fair"

Ineffectual

Ineffectual: "Ineffectual"

NoneLawless

NoneLawless: "None / lawless"

Oppressive

Oppressive: "Oppressive"

Tolerant

Tolerant: "Tolerant"

Unyielding

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 14c1649f5..244ea6fd6 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

Enumeration Behavior

Set by Oracles / Creatures / Encountered Behavior

-
alpha

Index

Enumeration Members

Enumeration Members

Ambusher

Ambusher: "Ambusher"

ApexPredator

ApexPredator: "Apex predator"

Builder

Builder: "Builder"

Camouflager

Camouflager: "Camouflager"

Forager

Forager: "Forager"

Grazer

Grazer: "Grazer"

Herder

Herder: "Herder"

Hibernator

Hibernator: "Hibernator"

Hoarder

Hoarder: "Hoarder"

Hunter

Hunter: "Hunter"

Lurer

Lurer: "Lurer"

Migratory

Migratory: "Migratory"

Mimic

Mimic: "Mimic"

Nester

Nester: "Nester"

PackHunter

PackHunter: "Pack hunter"

Prey

Prey: "Prey"

Protector

Protector: "Protector"

Scavenger

Scavenger: "Scavenger"

Tracker

Tracker: "Tracker"

Trapper

Trapper: "Trapper"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Ambusher

Ambusher: "Ambusher"

ApexPredator

ApexPredator: "Apex predator"

Builder

Builder: "Builder"

Camouflager

Camouflager: "Camouflager"

Forager

Forager: "Forager"

Grazer

Grazer: "Grazer"

Herder

Herder: "Herder"

Hibernator

Hibernator: "Hibernator"

Hoarder

Hoarder: "Hoarder"

Hunter

Hunter: "Hunter"

Lurer

Lurer: "Lurer"

Migratory

Migratory: "Migratory"

Mimic

Mimic: "Mimic"

Nester

Nester: "Nester"

PackHunter

PackHunter: "Pack hunter"

Prey

Prey: "Prey"

Protector

Protector: "Protector"

Scavenger

Scavenger: "Scavenger"

Tracker

Tracker: "Tracker"

Trapper

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 130992d7b..2057f666f 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

Enumeration CreatureScale

Set by Oracles / Creatures / Scale/**

-
alpha

Index

Enumeration Members

Enumeration Members

Colossal

Colossal: "Colossal"

Huge

Huge: "Huge"

Large

Large: "Large"

Medium

Medium: "Medium"

Minuscule

Minuscule: "Minuscule"

Small

Small: "Small"

Tiny

Tiny: "Tiny"

Titanic

Titanic: "Titanic"

Vast

Vast: "Vast"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Colossal

Colossal: "Colossal"

Huge

Huge: "Huge"

Large

Large: "Large"

Medium

Medium: "Medium"

Minuscule

Minuscule: "Minuscule"

Small

Small: "Small"

Tiny

Tiny: "Tiny"

Titanic

Titanic: "Titanic"

Vast

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 01c52cde2..c073976fa 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

Enumeration DerelictType

Set by oracle: Oracles / Derelicts / Type

-
alpha

Index

Enumeration Members

Enumeration Members

Settlement

Settlement: "Settlement"

Starship

Starship: "Starship"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Settlement

Settlement: "Settlement"

Starship

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 050ec1450..60c4e54c8 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

Enumeration Disposition

Set by Oracles / Characters / Disposition

-
alpha

Index

Enumeration Members

Enumeration Members

Cooperative

Cooperative: "Cooperative"

Curious

Curious: "Curious"

Demanding

Demanding: "Demanding"

Desperate

Desperate: "Desperate"

Friendly

Friendly: "Friendly"

Helpful

Helpful: "Helpful"

Hostile

Hostile: "Hostile"

Indifferent

Indifferent: "Indifferent"

Suspicious

Suspicious: "Suspicious"

Threatening

Threatening: "Threatening"

Unfriendly

Unfriendly: "Unfriendly"

Wanting

Wanting: "Wanting"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Cooperative

Cooperative: "Cooperative"

Curious

Curious: "Curious"

Demanding

Demanding: "Demanding"

Desperate

Desperate: "Desperate"

Friendly

Friendly: "Friendly"

Helpful

Helpful: "Helpful"

Hostile

Hostile: "Hostile"

Indifferent

Indifferent: "Indifferent"

Suspicious

Suspicious: "Suspicious"

Threatening

Threatening: "Threatening"

Unfriendly

Unfriendly: "Unfriendly"

Wanting

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 7b8a1d563..322840eba 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

Enumeration Diversity

Set by Oracles / Planets / Vital / Diversity

-
alpha

Index

Enumeration Members

Enumeration Members

Complex

Complex: 4

Diverse

Diverse: 3

GardenWorld

GardenWorld: 5

Simple

Simple: 2

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Complex

Complex: 4

Diverse

Diverse: 3

GardenWorld

GardenWorld: 5

Simple

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 9a15b02d0..08f93634d 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

Enumeration Dominion

Set by Oracles / Factions / Dominion

-
alpha

Index

Enumeration Members

Enumeration Members

Agriculture

Agriculture: "Agriculture"

Artistry

Artistry: "Artistry"

Commerce

Commerce: "Commerce"

Conquest

Conquest: "Conquest"

Construction

Construction: "Construction"

Diplomacy

Diplomacy: "Diplomacy"

Education

Education: "Education"

Environmentalism

Environmentalism: "Environmentalism"

Exploration

Exploration: "Exploration"

Faith

Faith: "Faith"

History

History: "History"

Honor

Honor: "Honor"

Industry

Industry: "Industry"

Isolationism

Isolationism: "Isolationism"

Law

Law: "Law"

Mysticism

Mysticism: "Mysticism"

Pacifism

Pacifism: "Pacifism"

Prophecy

Prophecy: "Prophecy"

Science

Science: "Science"

Secrecy

Secrecy: "Secrecy"

Technology

Technology: "Technology"

Treachery

Treachery: "Treachery"

Warfare

Warfare: "Warfare"

Wealth

Wealth: "Wealth"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Agriculture

Agriculture: "Agriculture"

Artistry

Artistry: "Artistry"

Commerce

Commerce: "Commerce"

Conquest

Conquest: "Conquest"

Construction

Construction: "Construction"

Diplomacy

Diplomacy: "Diplomacy"

Education

Education: "Education"

Environmentalism

Environmentalism: "Environmentalism"

Exploration

Exploration: "Exploration"

Faith

Faith: "Faith"

History

History: "History"

Honor

Honor: "Honor"

Industry

Industry: "Industry"

Isolationism

Isolationism: "Isolationism"

Law

Law: "Law"

Mysticism

Mysticism: "Mysticism"

Pacifism

Pacifism: "Pacifism"

Prophecy

Prophecy: "Prophecy"

Science

Science: "Science"

Secrecy

Secrecy: "Secrecy"

Technology

Technology: "Technology"

Treachery

Treachery: "Treachery"

Warfare

Warfare: "Warfare"

Wealth

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 df022c202..e26345a38 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

Enumeration Environment

Set by Oracles / Creatures / Environment

-
alpha

Index

Enumeration Members

Enumeration Members

Air

Air: "Air"

Interior

Interior: "Interior"

Land

Land: "Land"

Liquid

Liquid: "Liquid"

Space

Space: "Space"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Air

Air: "Air"

Interior

Interior: "Interior"

Land

Land: "Land"

Liquid

Liquid: "Liquid"

Space

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 5eeb1596d..570916ef0 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

Enumeration FactionType

Set by Oracles / Factions / Type

-
alpha

Index

Enumeration Members

Enumeration Members

Dominion

Dominion: "Dominion"

FringeGroup

FringeGroup: "Fringe Group"

Guild

Guild: "Guild"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Dominion

Dominion: "Dominion"

FringeGroup

FringeGroup: "Fringe Group"

Guild

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 3c7fe37be..5544b1bc7 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

Enumeration FringeGroup

Set by Oracles / Factions / Fringe Group

-
alpha

Index

Enumeration Members

Enumeration Members

Cultists

Cultists: "Cultists"

Exiles

Exiles: "Exiles"

Gangsters

Gangsters: "Gangsters"

Hackers

Hackers: "Hackers"

MonsterHunters

MonsterHunters: "Monster hunters"

Pirates

Pirates: "Pirates"

Raiders

Raiders: "Raiders"

Rebels

Rebels: "Rebels"

RogueAI

RogueAI: "Rogue AI"

Scavengers

Scavengers: "Scavengers"

Smugglers

Smugglers: "Smugglers"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Cultists

Cultists: "Cultists"

Exiles

Exiles: "Exiles"

Gangsters

Gangsters: "Gangsters"

Hackers

Hackers: "Hackers"

MonsterHunters

MonsterHunters: "Monster hunters"

Pirates

Pirates: "Pirates"

Raiders

Raiders: "Raiders"

Rebels

Rebels: "Rebels"

RogueAI

RogueAI: "Rogue AI"

Scavengers

Scavengers: "Scavengers"

Smugglers

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 a1968d0bd..45ef5d1d5 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

Enumeration GameObjectType

Index

Enumeration Members

Enumeration Members

Character

Character: "Character"

Creature

Creature: "Creature"

Derelict

Derelict: "Derelict"

DerelictZone

DerelictZone: "Derelict Zone"

Faction

Faction: "Faction"

Planet

Planet: "Planet"

PrecursorVault

PrecursorVault: "Precursor Vault"

Settlement

Settlement: "Settlement"

Starship

Starship: "Starship"

Generated using TypeDoc

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

Enumeration GameObjectType

Index

Enumeration Members

Enumeration Members

Character

Character: "Character"

Creature

Creature: "Creature"

Derelict

Derelict: "Derelict"

DerelictZone

DerelictZone: "Derelict Zone"

Faction

Faction: "Faction"

Planet

Planet: "Planet"

PrecursorVault

PrecursorVault: "Precursor Vault"

Settlement

Settlement: "Settlement"

Starship

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 223dfffc8..1dad18bb2 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

Enumeration Guild

Set by Oracles / Factions / Guild

-
alpha

Index

Enumeration Members

Enumeration Members

Assassins

Assassins: "Assassins"

BountyHunters

BountyHunters: "Bounty Hunters"

Couriers

Couriers: "Couriers"

Courtesans

Courtesans: "Courtesans"

Engineers

Engineers: "Engineers"

Healers

Healers: "Healers"

Industrialists

Industrialists: "Industrialists"

Mercenaries

Mercenaries: "Mercenaries"

Merchants

Merchants: "Merchants"

Mystics

Mystics: "Mystics"

Navigators

Navigators: "Navigators"

Peacekeepers

Peacekeepers: "Peacekeepers"

Researchers

Researchers: "Researchers"

Spies

Spies: "Spies"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Assassins

Assassins: "Assassins"

BountyHunters

BountyHunters: "Bounty Hunters"

Couriers

Couriers: "Couriers"

Courtesans

Courtesans: "Courtesans"

Engineers

Engineers: "Engineers"

Healers

Healers: "Healers"

Industrialists

Industrialists: "Industrialists"

Mercenaries

Mercenaries: "Mercenaries"

Merchants

Merchants: "Merchants"

Mystics

Mystics: "Mystics"

Navigators

Navigators: "Navigators"

Peacekeepers

Peacekeepers: "Peacekeepers"

Researchers

Researchers: "Researchers"

Spies

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 76ef60466..c5a063b44 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

Enumeration Influence

Set by Oracles / Factions / Influence

-
alpha

Index

Enumeration Members

Enumeration Members

Dominant

Dominant: "Dominant"

Established

Established: "Established"

Forsaken

Forsaken: "Forsaken"

Inescapable

Inescapable: "Inescapable"

Isolated

Isolated: "Isolated"

Localized

Localized: "Localized"

Notable

Notable: "Notable"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Dominant

Dominant: "Dominant"

Established

Established: "Established"

Forsaken

Forsaken: "Forsaken"

Inescapable

Inescapable: "Inescapable"

Isolated

Isolated: "Isolated"

Localized

Localized: "Localized"

Notable

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 266b9be95..27db71d6d 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

Enumeration Leadership

Set by Oracles / Factions / Leadership

-
alpha

Index

Enumeration Members

Enumeration Members

Anarchist

Anarchist: "Anarchist"

AuthoritarianDictatorship

AuthoritarianDictatorship: "Authoritarian dictatorship"

ClanChiefsOrElders

ClanChiefsOrElders: "Clan chiefs or elders"

DisputedLeadership

DisputedLeadership: "Disputed leadership"

DynasticLineage

DynasticLineage: "Dynastic lineage"

ElectedRepresentatives

ElectedRepresentatives: "Elected representatives"

FatedOrProphesiedLeader

FatedOrProphesiedLeader: "Fated or prophesied leader"

MachineIntelligence

MachineIntelligence: "Machine intelligence"

OligarchicalElite

OligarchicalElite: "Oligarchical elite"

VariedDecentralized

VariedDecentralized: "Varied / decentralized"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Anarchist

Anarchist: "Anarchist"

AuthoritarianDictatorship

AuthoritarianDictatorship: "Authoritarian dictatorship"

ClanChiefsOrElders

ClanChiefsOrElders: "Clan chiefs or elders"

DisputedLeadership

DisputedLeadership: "Disputed leadership"

DynasticLineage

DynasticLineage: "Dynastic lineage"

ElectedRepresentatives

ElectedRepresentatives: "Elected representatives"

FatedOrProphesiedLeader

FatedOrProphesiedLeader: "Fated or prophesied leader"

MachineIntelligence

MachineIntelligence: "Machine intelligence"

OligarchicalElite

OligarchicalElite: "Oligarchical elite"

VariedDecentralized

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 892e5a716..bbb4602f7 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

Enumeration Life

Set by Oracles / Planets / * / Life

-
alpha

Index

Enumeration Members

Enumeration Members

Bountiful

Bountiful: "Bountiful"

Diverse

Diverse: "Diverse"

Extinct

Extinct: "Extinct"

None

None: "None"

Overrun

Overrun: "Overrun"

Scarce

Scarce: "Scarce"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Bountiful

Bountiful: "Bountiful"

Diverse

Diverse: "Diverse"

Extinct

Extinct: "Extinct"

None

None: "None"

Overrun

Overrun: "Overrun"

Scarce

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 f37dee4eb..9299c29b8 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

Enumeration Location

Set by Oracles / ** / Location

-
alpha

Index

Enumeration Members

Enumeration Members

DeepSpace

DeepSpace: "Deep Space"

Orbital

Orbital: "Orbital"

Planetside

Planetside: "Planetside"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

DeepSpace

DeepSpace: "Deep Space"

Orbital

Orbital: "Orbital"

Planetside

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 50b1e94de..569a1e7f4 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

Enumeration LocationTheme

Set by Oracles / Location Themes / Theme Type

-

Index

Enumeration Members

Enumeration Members

Chaotic

Chaotic: "Chaotic"

Fortified

Fortified: "Fortified"

Haunted

Haunted: "Haunted"

Infested

Infested: "Infested"

Inhabited

Inhabited: "Inhabited"

Mechanical

Mechanical: "Mechanical"

Ruined

Ruined: "Ruined"

Sacred

Sacred: "Sacred"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Chaotic

Chaotic: "Chaotic"

Fortified

Fortified: "Fortified"

Haunted

Haunted: "Haunted"

Infested

Infested: "Infested"

Inhabited

Inhabited: "Inhabited"

Mechanical

Mechanical: "Mechanical"

Ruined

Ruined: "Ruined"

Sacred

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 5c48d1ff9..3f0bd79d5 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

Enumeration PlanetaryClass

Set by "Oracles / Planets / Class"

-

Index

Enumeration Members

Enumeration Members

Desert

Desert: "Desert"

Furnace

Furnace: "Furnace"

Grave

Grave: "Grave"

Ice

Ice: "Ice"

Jovian

Jovian: "Jovian"

Jungle

Jungle: "Jungle"

Ocean

Ocean: "Ocean"

Rocky

Rocky: "Rocky"

Shattered

Shattered: "Shattered"

Tainted

Tainted: "Tainted"

Vital

Vital: "Vital"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Desert

Desert: "Desert"

Furnace

Furnace: "Furnace"

Grave

Grave: "Grave"

Ice

Ice: "Ice"

Jovian

Jovian: "Jovian"

Jungle

Jungle: "Jungle"

Ocean

Ocean: "Ocean"

Rocky

Rocky: "Rocky"

Shattered

Shattered: "Shattered"

Tainted

Tainted: "Tainted"

Vital

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 d55625bd2..30d36b249 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

Enumeration Population

Set by Oracles / Settlements / Population

-
alpha

Index

Enumeration Members

Enumeration Members

Dozens

Dozens: "Dozens"

Few

Few: "Few"

Hundreds

Hundreds: "Hundreds"

TensOfThousands

TensOfThousands: "Tens of thousands"

Thousands

Thousands: "Thousands"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

Dozens

Dozens: "Dozens"

Few

Few: "Few"

Hundreds

Hundreds: "Hundreds"

TensOfThousands

TensOfThousands: "Tens of thousands"

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 41980a007..26b4a4fd8 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

Enumeration Region

alpha

Index

Enumeration Members

Enumeration Members

Expanse

Expanse: "Expanse"

Outlands

Outlands: "Outlands"

Terminus

Terminus: "Terminus"

Generated using TypeDoc

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

Enumeration Region

alpha

Index

Enumeration Members

Enumeration Members

Expanse

Expanse: "Expanse"

Outlands

Outlands: "Outlands"

Terminus

Terminus: "Terminus"

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 8ed103f68..0dd9a7969 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

Enumeration Role

Set by Oracles / Character / Role

-
alpha

Index

Enumeration Members

Enumeration Members

AI

AI: "AI"

Agent

Agent: "Agent"

Artisan

Artisan: "Artisan"

Assassin

Assassin: "Assassin"

BountyHunter

BountyHunter: "Hunter"

Courier

Courier: "Courier"

Crew

Crew: "Crew"

Criminal

Criminal: "Criminal"

Cultist

Cultist: "Cultist"

Diplomat

Diplomat: "Diplomat"

Engineer

Engineer: "Engineer"

Entertainer

Entertainer: "Entertainer"

Explorer

Explorer: "Explorer"

Farmer

Farmer: "Farmer"

Fugitive

Fugitive: "Fugitive"

Guard

Guard: "Guard"

Guide

Guide: "Guide"

Healer

Healer: "Healer"

Historian

Historian: "Historian"

Hunter

Hunter: "Hunter"

Investigator

Investigator: "Investigator"

Laborer

Laborer: "Laborer"

Lawkeeper

Lawkeeper: "Lawkeeper"

Leader

Leader: "Leader"

Mercenary

Mercenary: "Mercenary"

Merchant

Merchant: "Merchant"

Miner

Miner: "Miner"

Mystic

Mystic: "Mystic"

Navigator

Navigator: "Navigator"

Outcast

Outcast: "Outcast"

Pilgrim

Pilgrim: "Pilgrim"

Pilot

Pilot: "Pilot"

Pirate

Pirate: "Pirate"

Preacher

Preacher: "Preacher"

Prophet

Prophet: "Prophet"

Raider

Raider: "Raider"

Researcher

Researcher: "Researcher"

Scavenger

Scavenger: "Scavenger"

Scholar

Scholar: "Scholar"

Scout

Scout: "Scout"

Shipwright

Shipwright: "Shipwright"

Smuggler

Smuggler: "Smuggler"

Soldier

Soldier: "Soldier"

Spacer

Spacer: "Spacer"

Technician

Technician: "Technician"

Thief

Thief: "Thief"

Generated using TypeDoc

\ No newline at end of file +
alpha

Index

Enumeration Members

Enumeration Members

AI

AI: "AI"

Agent

Agent: "Agent"

Artisan

Artisan: "Artisan"

Assassin

Assassin: "Assassin"

BountyHunter

BountyHunter: "Hunter"

Courier

Courier: "Courier"

Crew

Crew: "Crew"

Criminal

Criminal: "Criminal"

Cultist

Cultist: "Cultist"

Diplomat

Diplomat: "Diplomat"

Engineer

Engineer: "Engineer"

Entertainer

Entertainer: "Entertainer"

Explorer

Explorer: "Explorer"

Farmer

Farmer: "Farmer"

Fugitive

Fugitive: "Fugitive"

Guard

Guard: "Guard"

Guide

Guide: "Guide"

Healer

Healer: "Healer"

Historian

Historian: "Historian"

Hunter

Hunter: "Hunter"

Investigator

Investigator: "Investigator"

Laborer

Laborer: "Laborer"

Lawkeeper

Lawkeeper: "Lawkeeper"

Leader

Leader: "Leader"

Mercenary

Mercenary: "Mercenary"

Merchant

Merchant: "Merchant"

Miner

Miner: "Miner"

Mystic

Mystic: "Mystic"

Navigator

Navigator: "Navigator"

Outcast

Outcast: "Outcast"

Pilgrim

Pilgrim: "Pilgrim"

Pilot

Pilot: "Pilot"

Pirate

Pirate: "Pirate"

Preacher

Preacher: "Preacher"

Prophet

Prophet: "Prophet"

Raider

Raider: "Raider"

Researcher

Researcher: "Researcher"

Scavenger

Scavenger: "Scavenger"

Scholar

Scholar: "Scholar"

Scout

Scout: "Scout"

Shipwright

Shipwright: "Shipwright"

Smuggler

Smuggler: "Smuggler"

Soldier

Soldier: "Soldier"

Spacer

Spacer: "Spacer"

Technician

Technician: "Technician"

Thief

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 61d7830f9..48d7dc547 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

alpha

Index

Enumeration Members

Enumeration Members

AskingForHelp

AskingForHelp: "Asking for help"

Captured

Captured: "Captured"

Derelict

Derelict: "Derelict"

Destroyed

Destroyed: "Destroyed"

Hostile

Hostile: "Hostile"

InBattle

InBattle: "In battle"

NeutralAutomated

NeutralAutomated: "Neutral / automated"

Uncooperative

Uncooperative: "Uncooperative"

Unresponsive

Unresponsive: "Unresponsive"

Wary

Wary: "Wary"

Welcoming

Welcoming: "Welcoming"

Generated using TypeDoc

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

Enumeration SettlementInitialContact

alpha

Index

Enumeration Members

Enumeration Members

AskingForHelp

AskingForHelp: "Asking for help"

Captured

Captured: "Captured"

Derelict

Derelict: "Derelict"

Destroyed

Destroyed: "Destroyed"

Hostile

Hostile: "Hostile"

InBattle

InBattle: "In battle"

NeutralAutomated

NeutralAutomated: "Neutral / automated"

Uncooperative

Uncooperative: "Uncooperative"

Unresponsive

Unresponsive: "Unresponsive"

Wary

Wary: "Wary"

Welcoming

Welcoming: "Welcoming"

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 92e3fa48b..533ccda17 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

alpha

Index

Enumeration Members

Enumeration Members

AskingForHelp

AskingForHelp: "Asking for help"

Derelict

Derelict: "Derelict"

Destroyed

Destroyed: "Destroyed"

Dismissive

Dismissive: "Dismissive"

Familiar

Familiar: "Familiar"

Friendly

Friendly: "Friendly"

Hostile

Hostile: "Hostile"

InBattle

InBattle: "In battle"

NeutralAutomated

NeutralAutomated: "Neutral / automated"

Uncooperative

Uncooperative: "Uncooperative"

Unresponsive

Unresponsive: "Unresponsive"

Wary

Wary: "Wary"

Generated using TypeDoc

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

Enumeration StarshipInitialContact

alpha

Index

Enumeration Members

Enumeration Members

AskingForHelp

AskingForHelp: "Asking for help"

Derelict

Derelict: "Derelict"

Destroyed

Destroyed: "Destroyed"

Dismissive

Dismissive: "Dismissive"

Familiar

Familiar: "Familiar"

Friendly

Friendly: "Friendly"

Hostile

Hostile: "Hostile"

InBattle

InBattle: "In battle"

NeutralAutomated

NeutralAutomated: "Neutral / automated"

Uncooperative

Uncooperative: "Uncooperative"

Unresponsive

Unresponsive: "Unresponsive"

Wary

Wary: "Wary"

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 4fcc974af..edbcbe94d 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

Enumeration VaultZone

Index

Enumeration Members

Enumeration Members

Interior

Interior: "Interior"

Sanctum

Sanctum: "Sanctum"

Generated using TypeDoc

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

Enumeration VaultZone

Index

Enumeration Members

Enumeration Members

Interior

Interior: "Interior"

Sanctum

Sanctum: "Sanctum"

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 8bdbd1039..652704dd0 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

Enumeration Zone

Index

Enumeration Members

Enumeration Members

Access

Access: "Access"

Community

Community: "Community"

Engineering

Engineering: "Engineering"

Living

Living: "Living"

Medical

Medical: "Medical"

Operations

Operations: "Operations"

Production

Production: "Production"

Research

Research: "Research"

Generated using TypeDoc

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

Enumeration Zone

Index

Enumeration Members

Enumeration Members

Access

Access: "Access"

Community

Community: "Community"

Engineering

Engineering: "Engineering"

Living

Living: "Living"

Medical

Medical: "Medical"

Operations

Operations: "Operations"

Production

Production: "Production"

Research

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 8aa302772..fc52a88e3 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

Enumeration Members

Adjective

Adjective: "adjective"

CommonNoun

CommonNoun: "common noun"

CompoundNoun

CompoundNoun: "compound noun"

Fragment

Fragment: "fragment"

Name

Name: "name"

Noun

Noun: "noun"

Plural

Plural: "plural"

PossessiveCase

PossessiveCase: "possessive case"

ProperNoun

ProperNoun: "proper noun"

ProperNounFragment

ProperNounFragment: "proper noun fragment"

Sentences

Sentences: "sentences"

Verb

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

Enumeration Members

Adjective

Adjective: "adjective"

CommonNoun

CommonNoun: "common noun"

CompoundNoun

CompoundNoun: "compound noun"

Fragment

Fragment: "fragment"

Name

Name: "name"

Noun

Noun: "noun"

Plural

Plural: "plural"

PossessiveCase

PossessiveCase: "possessive case"

ProperNoun

ProperNoun: "proper noun"

ProperNounFragment

ProperNounFragment: "proper noun fragment"

Sentences

Sentences: "sentences"

Verb

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 d52d2f0dc..880624b47 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

Enumeration Members

Custom

Custom: "Custom"

Ironsworn

Ironsworn: "Ironsworn Rulebook"

IronswornAssets

IronswornAssets: "Ironsworn Assets"

IronswornBonusAssets

IronswornBonusAssets: "Ironsworn Bonus Assets (July 2020)"

IronswornDelve

IronswornDelve: "Ironsworn: Delve"

Starforged

Starforged: "Ironsworn: Starforged Rulebook"

StarforgedAssets

StarforgedAssets: "Ironsworn: Starforged Assets"

SunderedIslesPreview

SunderedIslesPreview: "Sundered Isles Preview"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Custom

Custom: "Custom"

Ironsworn

Ironsworn: "Ironsworn Rulebook"

IronswornAssets

IronswornAssets: "Ironsworn Assets"

IronswornBonusAssets

IronswornBonusAssets: "Ironsworn Bonus Assets (July 2020)"

IronswornDelve

IronswornDelve: "Ironsworn: Delve"

Starforged

Starforged: "Ironsworn: Starforged Rulebook"

StarforgedAssets

StarforgedAssets: "Ironsworn: Starforged Assets"

SunderedIslesPreview

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 9b48631c5..1d21f1781 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

Enumeration Members

Ironsworn

Ironsworn: "https://shawn-tomkin.itch.io/ironsworn"

IronswornAssets

IronswornAssets: "https://shawn-tomkin.itch.io/ironsworn"

IronswornBonusAssets

IronswornBonusAssets: "https://drive.google.com/file/d/1bWyWxJzV_SVtyE_SeEGS4TMJ1ZBHfrdv/view"

IronswornDelve

IronswornDelve: "https://shawn-tomkin.itch.io/ironsworn-delve"

Starforged

Starforged: "https://getstarforged.com"

StarforgedAssets

StarforgedAssets: "https://getstarforged.com"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Ironsworn

Ironsworn: "https://shawn-tomkin.itch.io/ironsworn"

IronswornAssets

IronswornAssets: "https://shawn-tomkin.itch.io/ironsworn"

IronswornBonusAssets

IronswornBonusAssets: "https://drive.google.com/file/d/1bWyWxJzV_SVtyE_SeEGS4TMJ1ZBHfrdv/view"

IronswornDelve

IronswornDelve: "https://shawn-tomkin.itch.io/ironsworn-delve"

Starforged

Starforged: "https://getstarforged.com"

StarforgedAssets

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 32358d0a5..a8984ea85 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

Enumeration Members

Adventure

Adventure: "Adventure"

Combat

Combat: "Combat"

Connection

Connection: "Connection"

Exploration

Exploration: "Exploration"

Fate

Fate: "Fate"

Legacy

Legacy: "Legacy"

Quest

Quest: "Quest"

Recover

Recover: "Recover"

Session

Session: "Session"

Suffer

Suffer: "Suffer"

Threshold

Threshold: "Threshold"

Generated using TypeDoc

\ No newline at end of file +

Index

Enumeration Members

Enumeration Members

Adventure

Adventure: "Adventure"

Combat

Combat: "Combat"

Connection

Connection: "Connection"

Exploration

Exploration: "Exploration"

Fate

Fate: "Fate"

Legacy

Legacy: "Legacy"

Quest

Quest: "Quest"

Recover

Recover: "Recover"

Session

Session: "Session"

Suffer

Suffer: "Suffer"

Threshold

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 8b994670d..a7005d8b8 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

Index

Enumeration Members

Enumeration Members

Miss

Miss: 0

Strong Hit

Strong Hit: 2

Weak Hit

Weak Hit: 1

Generated using TypeDoc

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

Enumeration MoveOutcome

Index

Enumeration Members

Enumeration Members

Miss

Miss: 0

Strong Hit

Strong Hit: 2

Weak Hit

Weak Hit: 1

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 c4244db77..4f697deee 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

Enumeration Members

ActionDie

ActionDie: "Action die"
+

Index

Enumeration Members

Enumeration Members

ActionDie

ActionDie: "Action die"

The action die is rerolled.

-

All

All: "All"
+

All

All: "All"

Reroll all dice

-

Any

Any: "Any"
+

Any

Any: "Any"

The player can pick and choose which dice to reroll.

-

ChallengeDice

ChallengeDice: "Challenge dice"
+

ChallengeDice

ChallengeDice: "Challenge dice"

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

-

ChallengeDie

ChallengeDie: "Challenge die"
+

ChallengeDie

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 d9502aeb0..f25593671 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

Enumeration Members

All

All: "All"
+

Index

Enumeration Members

Enumeration Members

All

All: "All"

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

-

Any

Any: "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

Highest: "Highest"

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

-

Inherit

Inherit: "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

Lowest: "Lowest"

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

-

StrongHit

StrongHit: "Strong Hit"
+

StrongHit

StrongHit: "Strong Hit"

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

-

WeakHit

WeakHit: "Weak Hit"
+

WeakHit

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 f4cb74a9b..7369099f3 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

Enumeration RollType

Index

Enumeration Members

Enumeration Members

Action

Action: "Action roll"

Progress

Progress: "Progress roll"

Generated using TypeDoc

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

Enumeration RollType

Index

Enumeration Members

Enumeration Members

Action

Action: "Action roll"

Progress

Progress: "Progress roll"

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 09824078f..686eff9ba 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

Enumeration SettingTruthName

Index

Enumeration Members

Enumeration Members

ArtificialIntelligence

ArtificialIntelligence: "Artificial Intelligence"

Cataclysm

Cataclysm: "Cataclysm"

CommunicationAndData

CommunicationAndData: "Communication and Data"

Communities

Communities: "Communities"

Exodus

Exodus: "Exodus"

Horrors

Horrors: "Horrors"

Iron

Iron: "Iron"

Laws

Laws: "Laws"

Lifeforms

Lifeforms: "Lifeforms"

Magic

Magic: "Magic"

Medicine

Medicine: "Medicine"

Precursors

Precursors: "Precursors"

Religion

Religion: "Religion"

War

War: "War"

Generated using TypeDoc

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

Enumeration SettingTruthName

Index

Enumeration Members

Enumeration Members

ArtificialIntelligence

ArtificialIntelligence: "Artificial Intelligence"

Cataclysm

Cataclysm: "Cataclysm"

CommunicationAndData

CommunicationAndData: "Communication and Data"

Communities

Communities: "Communities"

Exodus

Exodus: "Exodus"

Horrors

Horrors: "Horrors"

Iron

Iron: "Iron"

Laws

Laws: "Laws"

Lifeforms

Lifeforms: "Lifeforms"

Magic

Magic: "Magic"

Medicine

Medicine: "Medicine"

Precursors

Precursors: "Precursors"

Religion

Religion: "Religion"

War

War: "War"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index b3b6db009..5d40ed270 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.3.2

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

Dataforged API

Dataforged v1.4.0

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

Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMomentum

Hierarchy

  • IAlterMomentum

Index

Properties

Properties

Optional Burn

Burn?: IAlterMomentumBurn[]
+IAlterMomentum | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAlterMomentum

Hierarchy

  • IAlterMomentum

Index

Properties

Properties

Optional Burn

Burn?: IAlterMomentumBurn[]

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

-

Optional Reset

Reset?: IAlterMomentumReset[]
+

Optional Reset

Reset?: IAlterMomentumReset[]

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 a67aeea61..083ea1bb2 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

Properties

Effect

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

Interface IAlterMomentumBurn

Hierarchy

  • IAlterMomentumBurn

Index

Properties

Properties

Effect

Effect: IHasText

The effect altering the PC's momentum burn.

-

Optional Outcomes

Outcomes?: ("Weak Hit" | "Strong Hit")[]

Trigger

Trigger: IHasText
+

Optional Outcomes

Outcomes?: ("Weak Hit" | "Strong Hit")[]

Trigger

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 88aa02c60..5865d77dd 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

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

Interface IAlterMomentumReset

Hierarchy

  • IAlterMomentumReset

Index

Properties

Properties

Trigger

Trigger: IHasText

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

-

Value

Value: number
+

Value

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 0a4cdf702..53fc9cd85 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

Interface IAlterMove

Describes alterations applied to moves by asset abilities.

-

Hierarchy

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

Index

Properties

Properties

$id

$id: string
pattern

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

-

Optional Alters

Alters?: string[]
+

Hierarchy

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

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Alters

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.

-

Optional Asset

Asset?: string
+

Optional Asset

Asset?: string

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

-

Optional Moves

Moves?: null | string[]
+

Optional Moves

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

Optional Oracles

Oracles?: string[]
+
nullable

Optional Oracles

Oracles?: string[]

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

-

Optional Outcomes

Outcomes?: IAlterMoveOutcomes
+

Optional Outcomes

Outcomes?: IAlterMoveOutcomes

Added rules text that applies on move outcomes.

-

Optional Progress Move

Progress Move?: boolean
+

Optional Progress Move

Progress Move?: boolean

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

-

Optional Suggestions

Suggestions?: ISuggestions
+

Optional Suggestions

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.

-

Optional Tags

Tags?: string[]

Optional Text

Text?: string
+

Optional Tags

Tags?: string[]

Optional Text

Text?: string

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

-

Optional Trigger

Trigger?: IMoveTrigger
+

Optional Trigger

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

-

Optional Variant of

Variant of?: string
+

Optional Variant of

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 a50b217e4..357e8c5da 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

Properties

$id

$id: string
pattern

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

-

Optional Miss

Miss?: IAlterOutcomeInfo

Optional Strong Hit

Strong Hit?: IAlterOutcomeInfo

Optional Weak Hit

Weak 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

Properties

$id

$id: string
pattern

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

+

Optional Miss

Miss?: IAlterOutcomeInfo

Optional Strong Hit

Strong Hit?: IAlterOutcomeInfo

Optional Weak Hit

Weak 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 e5b7b3987..c5eaadb27 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

Properties

Optional $id

$id?: string
pattern

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

-

Optional Count as

Count as?: 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

Properties

Optional $id

$id?: string
pattern

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

+

Optional Count as

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

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

-

Optional In Control

In Control?: Partial<undefined | boolean>
+

Optional In Control

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.

-

Optional Reroll

Reroll?: Partial<undefined | IMoveReroll>
+

Optional Reroll

Reroll?: Partial<undefined | IMoveReroll>

Information on rerolls offered by this move.

-

Optional Text

Text?: string
+

Optional Text

Text?: string

The item's rules text as a markdown string.

-
markdown

Optional With a Match

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

Optional With a Match

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 071830131..1ed38dd18 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

Interface IAsset

An interface representing an Ironsworn: Starforged asset card.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Assets/Path/Bounty_Hunter"

+

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Assets/Path/Bounty_Hunter"

pattern

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

-

Abilities

Abilities: [IAssetAbility, IAssetAbility, IAssetAbility]
+

Abilities

Abilities: [IAssetAbility, IAssetAbility, IAssetAbility]

The asset's abilities.

-

Optional Aliases

Aliases?: string[]
+

Optional Aliases

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

Asset Type: string
+

Asset Type

Asset Type: string

The ID of the asset's parent AssetType

example

"Starforged/Assets/Path"

-

Optional Attachments

Attachments?: IAssetAttachment
+

Optional Attachments

Attachments?: IAssetAttachment

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

-

Optional Condition Meter

Condition Meter?: IConditionMeter
+

Optional Condition Meter

Condition Meter?: IConditionMeter

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

-

Display

Display: IDisplayWithTitle
+

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Optional Inputs

Inputs?: (IInputText | IInputSelect)[]
+

Optional Inputs

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

Name: string
+

Name

Name: string

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

example

"Bounty Hunter"

-

Optional Requirement

Requirement?: string
+

Optional Requirement

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

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Optional States

States?: IAssetState[]
+

Optional States

States?: IAssetState[]

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

-

Optional Tags

Tags?: string[]

Usage

Usage: IAssetUsage
+

Optional Tags

Tags?: string[]

Usage

Usage: 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
  • 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 e2efb52b5..22a3e58b0 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

Interface IAssetAbility

Represents one of an asset's three abilities.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Optional Alter Momentum

Alter Momentum?: IAlterMomentum
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Alter Momentum

Alter Momentum?: IAlterMomentum

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

-

Optional Alter Moves

Alter Moves?: IAlterMove[]
+

Optional Alter Moves

Alter Moves?: IAlterMove[]

Information on how this ability alters moves when enabled.

-

Optional Alter Properties

Alter Properties?: IAssetAlterProperties
+

Optional Alter Properties

Alter Properties?: IAssetAlterProperties

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

-

Enabled

Enabled: boolean
+

Enabled

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.

-

Optional Inputs

Inputs?: (IInputText | IInputNumber | IInputClock)[]
+

Optional Inputs

Inputs?: (IInputText | IInputNumber | IInputClock)[]

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

-

Optional Moves

Moves?: IMove[]
+

Optional Moves

Moves?: IMove[]

New moves added by this asset ability.

-

Optional Name

Name?: string
+

Optional Name

Name?: string

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

-

Text

Text: string
+

Text

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 c611482e0..698438f77 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

Properties

Optional $id

$id?: string
example

"Starforged/Assets/Path/Bounty_Hunter"

+

Hierarchy

  • PartialDeep<IAsset>
    • IAssetAlterProperties

Index

Properties

Properties

Optional $id

$id?: string
example

"Starforged/Assets/Path/Bounty_Hunter"

pattern

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

-

Optional Abilities

Abilities?: [IAssetAbility, IAssetAbility, IAssetAbility]
+

Optional Abilities

Abilities?: [IAssetAbility, IAssetAbility, IAssetAbility]

The asset's abilities.

-

Optional Aliases

Aliases?: Partial<undefined | string[]>
+

Optional Aliases

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.

-

Optional Asset Type

Asset Type?: string
+

Optional Asset Type

Asset Type?: string

The ID of the asset's parent AssetType

example

"Starforged/Assets/Path"

-

Optional Attachments

Attachments?: Partial<undefined | IAssetAttachment>
+

Optional Attachments

Attachments?: Partial<undefined | IAssetAttachment>

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

-

Optional Condition Meter

Condition Meter?: Partial<undefined | IConditionMeter>
+

Optional Condition Meter

Condition Meter?: Partial<undefined | IConditionMeter>

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

-

Optional Display

Display?: Partial<IDisplayWithTitle>

Optional Inputs

Inputs?: Partial<undefined | (IInputText | IInputSelect)[]>
+

Optional Display

Display?: Partial<IDisplayWithTitle>

Optional Inputs

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.

-

Optional Name

Name?: string
+

Optional Name

Name?: string

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

example

"Bounty Hunter"

-

Optional Requirement

Requirement?: Partial<undefined | string>
+

Optional Requirement

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

-

Optional Source

Source?: Partial<ISource>
+

Optional Source

Source?: Partial<ISource>

Information on this item's source.

-

Optional States

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

Optional States

States?: Partial<undefined | IAssetState[]>

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

-

Optional Tags

Tags?: Partial<undefined | string[]>

Optional Usage

Usage?: Partial<IAssetUsage>
+

Optional Tags

Tags?: Partial<undefined | string[]>

Optional Usage

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 17257b6e9..2534d5eee 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

Interface IAssetAttachment

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

Asset Types: string[]
+

Hierarchy

  • IAssetAttachment

Index

Properties

Properties

Asset Types

Asset Types: string[]

The type of asset that this asset accepts as attachments.

-

Max

Max: null | number
+

Max

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 d0a073c71..dfdcb85bd 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

Interface IAssetState

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

Properties

Disables asset

Disables asset: boolean
+

Hierarchy

Index

Properties

Properties

Disables asset

Disables asset: boolean

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

-

Enabled

Enabled: boolean
+

Enabled

Enabled: boolean

Whether this state is currently enabled.

-

Impact

Impact: boolean
+

Impact

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

Name: string
+

Name

Name: string

A string label name or label for the state.

example

"Broken"

-

Permanent

Permanent: boolean
+

Permanent

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 2b1a695be..f094f7c26 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

Interface IAssetType

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

Properties

$id

$id: string
example

"Ironsworn/Assets/Ritual"

+

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Ironsworn/Assets/Ritual"

example

"Starforged/Assets/Command_Vehicle"

pattern

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

-

Optional Aliases

Aliases?: string[]
+

Optional Aliases

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

Assets: IAsset[]
+

Assets

Assets: IAsset[]

The assets that belong to this asset type.

-

Description

Description: string
+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Name

Name: string
example

"Ritual"

+

Name

Name: string
example

"Ritual"

example

"Command Vehicle"

-

Source

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Usage

Usage: IAssetUsage

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Usage

Usage: IAssetUsage

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 b41e76326..c0a621423 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

Interface IAssetUsage

Hierarchy

  • IAssetUsage

Index

Properties

Properties

Shared

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

Interface IAssetUsage

Hierarchy

  • IAssetUsage

Index

Properties

Properties

Shared

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 886af8de0..cc286efb9 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

Interface IInput

A stub interface representing an input widget of any type.

see

IInputNumber, IInputClock, IInputText, IInputSelect

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Adjustable

Adjustable: boolean
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Adjustable

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

Input Type: InputType

Name

Name: string
+

Input Type

Input Type: InputType

Name

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 0392497db..73dd05cef 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

Properties

$id

$id: string
pattern

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

-

Adjustable

Adjustable: boolean
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Adjustable

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

Clock Type: ClockType
+

Clock Type

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

Filled: number
+

Filled

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

Input Type: Clock

Name

Name: string
+

Input Type

Input Type: Clock

Name

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

Segments: ClockSegments
+

Segments

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 226c68cbd..b9ddeb450 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

Properties

$id

$id: string
pattern

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

-

Adjustable

Adjustable: boolean
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Adjustable

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

Input Type: Number

Max

Max: null | number
nullable

Min

Min: number

Name

Name: string
+

Input Type

Input Type: Number

Max

Max: null | number
nullable

Min

Min: number

Name

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

Step: 1

Value

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

Step: 1

Value

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 790d21dff..5efae99f7 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

Properties

$id

$id: string
pattern

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

-

Adjustable

Adjustable: boolean
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Adjustable

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

Input Type: Select

Name

Name: string
+

Input Type

Input Type: Select

Name

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.

-

Options

Options: IInputSelectOption[]

Sets

Sets: IInputSelectAttributeDefinition[]
+

Options

Options: IInputSelectOption[]

Sets

Sets: IInputSelectAttributeDefinition[]

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 d7ef69344..34985fe46 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

Key: string

Type

Type: InputSelectOptionType

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

Key: string

Type

Type: InputSelectOptionType

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 15b7041fd..cf96af193 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

$id: string
pattern

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

-

Name

Name: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Name

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.

-

Set

Set: (IInputSelectOptionSetterStat | IInputSelectOptionSetterMeter | IInputSelectOptionSetterNumber | IInputSelectOptionSetterString)[]
+

Set

Set: (IInputSelectOptionSetterStat | IInputSelectOptionSetterMeter | IInputSelectOptionSetterNumber | IInputSelectOptionSetterString)[]

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 36ef17d69..5b2fdeea3 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

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Key

Key: string

Type

Type: InputSelectOptionType

Value

Value: string | number

Generated using TypeDoc

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

Interface IInputSelectOptionSetter

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Key

Key: string

Type

Type: InputSelectOptionType

Value

Value: string | number

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 72755286b..1ff168bf6 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

A condition meter set by an IInputSelectOption.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Key

Key: string

Type

Type: ConditionMeter

Value

Value: PlayerConditionMeter

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Key

Key: string

Type

Type: ConditionMeter

Value

Value: PlayerConditionMeter

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 66a01ea25..a317d416c 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

$id: string
pattern

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

-

Key

Key: string

Type

Type: Number

Value

Value: number

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Key

Key: string

Type

Type: Number

Value

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 13a922527..1eff12cfc 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

$id: string
pattern

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

-

Key

Key: string

Type

Type: Stat

Value

Value: Stat

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Key

Key: string

Type

Type: Stat

Value

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 0bef26193..aba70fefa 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

$id: string
pattern

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

-

Key

Key: string

Type

Type: String

Value

Value: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Key

Key: string

Type

Type: String

Value

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 7d705c187..54bdeda0c 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

Properties

$id

$id: string
pattern

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

-

Adjustable

Adjustable: boolean
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Adjustable

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

Input Type: Text

Name

Name: string
+

Input Type

Input Type: Text

Name

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 1ac677b96..23363da47 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 IConditionMeter

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

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Optional Aliases

Aliases?: MeterAlias[]

Conditions

Conditions: MeterCondition[]
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Aliases

Aliases?: MeterAlias[]

Conditions

Conditions: MeterCondition[]

The conditions that can apply to this meter.

-

Max

Max: number
+

Max

Max: number

The maximum value of the meter.

-

Min

Min: 0
+

Min

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

Name: string
+

Name

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

Value: number
+

Value

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 5f42a42dc..0a6d44232 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

Interface ICustomStat

Hierarchy

Index

Properties

Properties

$id

$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

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

Interface ICustomStat

Hierarchy

Index

Properties

Properties

$id

$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

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.

-

Options

Options: ICustomStatOption[]

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Options

Options: ICustomStatOption[]

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 77bb50098..e3cf3e15a 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

$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

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

Interface ICustomStatOption

Hierarchy

Index

Properties

Properties

$id

$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

Name: string

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

-

Value

Value: number
+

Value

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 3dcd5b751..c2392a6b9 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 IMeterBase

Interface representing a Meter.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string

The item's unique string ID.

pattern

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

-

Max

Max: number
+

Max

Max: number

The maximum value of the meter.

-

Min

Min: number
+

Min

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

Name: string
+

Name

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

Value: number
+

Value

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 655448508..8017fdaad 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

Interface ICyclopediaEntry

Basic interface for elements common to "cyclopedia" style pages, such as Regions (Ironsworn) and Encounters (Ironsworn and Starforged)

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Description

Description: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Description

Description: string

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

-
markdown

Display

Display: IDisplay
+
markdown

Display

Display: IDisplay

Data relevant to this item's display/rendering.

-

Optional Features

Features?: string[]

Name

Name: string
+

Optional Features

Features?: string[]

Name

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.

-

Optional Quest Starter

Quest Starter?: string
+

Optional Quest Starter

Quest Starter?: string

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

-
markdown

Source

Source: ISource
+
markdown

Source

Source: ISource

Information on this item's source.

-

Optional Summary

Summary?: string
+

Optional Summary

Summary?: string

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

-
markdown

Optional Tags

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

Optional Tags

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 1e02b08db..1afd84123 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

Interface IEncounter

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

-

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Encounters/Chiton"

+

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Encounters/Chiton"

pattern

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

-

Description

Description: string
+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Drives

Drives: string[]

Features

Features: string[]

Name

Name: string
example

"Chiton"

-

Nature

Nature: EncounterNatureStarforged | EncounterNatureIronsworn
example

"Monster"

-

Quest Starter

Quest Starter: string
+

Drives

Drives: string[]

Features

Features: string[]

Name

Name: string
example

"Chiton"

+

Nature

Nature: EncounterNatureStarforged | EncounterNatureIronsworn
example

"Monster"

+

Quest Starter

Quest Starter: string

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

-

Rank

Rank: ChallengeRank

Source

Source: ISource
+

Rank

Rank: ChallengeRank

Source

Source: ISource

Information on this item's source.

-

Optional Summary

Summary?: string
example

"Insectoid horde"

-
markdown

Tactics

Tactics: string[]

Optional Tags

Tags?: Vehicle[]

Optional Your Truth

Your Truth?: string
+

Optional Summary

Summary?: string
example

"Insectoid horde"

+
markdown

Tactics

Tactics: string[]

Optional Tags

Tags?: Vehicle[]

Optional Your Truth

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 1a39dc5c0..a915f99c8 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 IEncounterBase

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

see

IEncounter, IEncounterVariant

-

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Encounters/Chiton"

+

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Encounters/Chiton"

pattern

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

-

Description

Description: string
+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Optional Drives

Drives?: string[]
markdown

Optional Features

Features?: string[]
markdown

Name

Name: string
example

"Chiton"

-

Nature

Nature: EncounterNatureStarforged | EncounterNatureIronsworn
example

"Monster"

-

Optional Quest Starter

Quest Starter?: string
+

Optional Drives

Drives?: string[]
markdown

Optional Features

Features?: string[]
markdown

Name

Name: string
example

"Chiton"

+

Nature

Nature: EncounterNatureStarforged | EncounterNatureIronsworn
example

"Monster"

+

Optional Quest Starter

Quest Starter?: string

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

-
markdown

Rank

Rank: ChallengeRank

Source

Source: ISource
+
markdown

Rank

Rank: ChallengeRank

Source

Source: ISource

Information on this item's source.

-

Optional Summary

Summary?: string
example

"Insectoid horde"

-
markdown

Optional Tactics

Tactics?: string[]
markdown

Optional Tags

Tags?: Vehicle[]

Optional Your Truth

Your Truth?: string
+

Optional Summary

Summary?: string
example

"Insectoid horde"

+
markdown

Optional Tactics

Tactics?: string[]
markdown

Optional Tags

Tags?: Vehicle[]

Optional Your Truth

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 7d397bf89..abad6e797 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

Interface IEncounterIronsworn

Represents an Ironsworn Encounter entry.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Description

Description: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Drives

Drives: string[]

Features

Features: string[]

Name

Name: string
example

"Chiton"

-

Nature

Nature: EncounterNatureIronsworn

Quest Starter

Quest Starter: string
+

Drives

Drives: string[]

Features

Features: string[]

Name

Name: string
example

"Chiton"

+

Nature

Nature: EncounterNatureIronsworn

Quest Starter

Quest Starter: string

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

-

Rank

Rank: ChallengeRank

Source

Source: ISource
+

Rank

Rank: ChallengeRank

Source

Source: ISource

Information on this item's source.

-

Optional Summary

Summary?: string

Tactics

Tactics: string[]

Optional Tags

Tags?: Vehicle[]

Optional Your Truth

Your Truth?: string
+

Optional Summary

Summary?: string

Tactics

Tactics: string[]

Optional Tags

Tags?: Vehicle[]

Optional Your Truth

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 fd60b3bb0..36e7ea09d 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

Interface IEncounterNatureInfo

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

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Description

Description: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Encounters

Encounters: IEncounterIronsworn[]

Name

Name: EncounterNatureIronsworn
+

Encounters

Encounters: IEncounterIronsworn[]

Name

Name: EncounterNatureIronsworn

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

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Summary

Summary: string
+

Summary

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 0309448d0..45d21341b 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

Interface IEncounterStarforged

Represents an Ironsworn: Starforged Encounter entry.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Description

Description: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Drives

Drives: string[]

Features

Features: string[]

Name

Name: string
example

"Chiton"

-

Nature

Nature: EncounterNatureStarforged

Quest Starter

Quest Starter: string
+

Drives

Drives: string[]

Features

Features: string[]

Name

Name: string
example

"Chiton"

+

Nature

Nature: EncounterNatureStarforged

Quest Starter

Quest Starter: string

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

-

Rank

Rank: ChallengeRank

Source

Source: ISource
+

Rank

Rank: ChallengeRank

Source

Source: ISource

Information on this item's source.

-

Summary

Summary: string

Tactics

Tactics: string[]

Optional Tags

Tags?: Vehicle[]

Variants

Variants: IEncounterVariant[]

Optional Your Truth

Your Truth?: string
+

Summary

Summary: string

Tactics

Tactics: string[]

Optional Tags

Tags?: Vehicle[]

Variants

Variants: IEncounterVariant[]

Optional Your Truth

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 390524595..e89456386 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

Interface IEncounterVariant

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

Properties

$id

$id: string
pattern

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

-

Description

Description: string
+

Hierarchy

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

Index

Properties

Properties

$id

$id: string
pattern

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

+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle

Name

Name: string
example

"Chiton"

-

Nature

Nature: EncounterNatureStarforged

Rank

Rank: ChallengeRank

Source

Source: ISource
+
markdown

Display

Display: IDisplayWithTitle

Name

Name: string
example

"Chiton"

+

Nature

Nature: EncounterNatureStarforged

Rank

Rank: ChallengeRank

Source

Source: ISource

Information on this item's source.

-

Optional Tags

Tags?: Vehicle[]

Variant of

Variant of: string

Generated using TypeDoc

\ No newline at end of file +

Optional Tags

Tags?: Vehicle[]

Variant of

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 fec6b541a..4a39ff578 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

Interface IIronswornRegion

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Description

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

Interface IIronswornRegion

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Description

Description: string

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

-
markdown

Display

Display: IDisplay
+
markdown

Display

Display: IDisplay

Data relevant to this item's display/rendering.

-

Features

Features: string[]

Name

Name: string
+

Features

Features: string[]

Name

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

Quest Starter: string
+

Quest Starter

Quest Starter: string

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

-

Source

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Summary

Summary: string
+

Summary

Summary: string

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

-

Optional Tags

Tags?: string[]

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +

Optional Tags

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 ce95f26fa..ece1a4408 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

Key

Key: AttributeKey

Optional Value

Value?: string

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Key

Key: AttributeKey

Optional Value

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 c7791928b..97683213f 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

Interface IAttributeChoices

Hierarchy

  • IAttributeChoices

Index

Properties

Properties

Key

Key: AttributeKey

Optional Values

Values?: string[]

Generated using TypeDoc

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

Interface IAttributeChoices

Hierarchy

  • IAttributeChoices

Index

Properties

Properties

Key

Key: AttributeKey

Optional Values

Values?: string[]

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 74299f284..4373c8f59 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

Interface IAttributeMaster

alpha

Hierarchy

  • IAttributeMaster

Index

Properties

Properties

Atmosphere

Atmosphere: Atmosphere

Authority

Authority: Authority

Creature Scale

Creature Scale: CreatureScale

Derelict Type

Derelict Type: DerelictType

Disposition

Disposition: Disposition

Dominion

Dominion: Dominion

Encountered Behavior

Encountered Behavior: Behavior

Environment

Environment: Environment

Faction Type

Faction Type: FactionType

Fringe Group

Fringe Group: FringeGroup

Guild

Guild: Guild

Influence

Influence: Influence

Initial Contact

Initial Contact: StarshipInitialContact | SettlementInitialContact

Leadership

Leadership: Leadership

Life

Life: Life

Location

Location: Location

Location Theme

Location Theme: LocationTheme

Planetary Class

Planetary Class: PlanetaryClass

Population

Population: Population

Region

Region: Region

Role

Role: Role

Zone

Zone: Zone

Generated using TypeDoc

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

Interface IAttributeMaster

alpha

Hierarchy

  • IAttributeMaster

Index

Properties

Properties

Atmosphere

Atmosphere: Atmosphere

Authority

Authority: Authority

Creature Scale

Creature Scale: CreatureScale

Derelict Type

Derelict Type: DerelictType

Disposition

Disposition: Disposition

Dominion

Dominion: Dominion

Encountered Behavior

Encountered Behavior: Behavior

Environment

Environment: Environment

Faction Type

Faction Type: FactionType

Fringe Group

Fringe Group: FringeGroup

Guild

Guild: Guild

Influence

Influence: Influence

Initial Contact

Initial Contact: StarshipInitialContact | SettlementInitialContact

Leadership

Leadership: Leadership

Life

Life: Life

Location

Location: Location

Location Theme

Location Theme: LocationTheme

Planetary Class

Planetary Class: PlanetaryClass

Population

Population: Population

Region

Region: Region

Role

Role: Role

Zone

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 04096eba3..d22e070d2 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

Interface IGameObject

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

-

Hierarchy

  • IGameObject

Index

Properties

Properties

Object type

Object type: GameObjectType

Optional Requires

Requires?: IRequirements

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Properties

Properties

Object type

Object type: GameObjectType

Optional Requires

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 1534a8787..9f5f0f478 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 IDisplay

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

-

Hierarchy

Index

Properties

Properties

Optional Color

Color?: string
+

Hierarchy

Index

Properties

Properties

Optional Color

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

-

Optional Icon

Icon?: string
+

Optional Icon

Icon?: string

A URL pointing to a single SVG icon.

pattern

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

-

Optional Images

Images?: string[]
+

Optional Images

Images?: string[]

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

pattern

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

-

Optional Title

Title?: string
+

Optional Title

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 067ce69da..5164f6a3d 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

Properties

Optional Color

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

Interface IDisplayWithTitle

Hierarchy

Index

Properties

Properties

Optional Color

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

-

Optional Icon

Icon?: string
+

Optional Icon

Icon?: string

A URL pointing to a single SVG icon.

pattern

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

-

Optional Images

Images?: string[]
+

Optional Images

Images?: string[]

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

pattern

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

-

Title

Title: string
+

Title

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 17d92a2cc..5799e22d2 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 IHasAliases

Interface for items with aliases.

-

Hierarchy

  • IHasAliases

Index

Properties

Properties

Aliases

Aliases: string[]
+

Hierarchy

  • IHasAliases

Index

Properties

Properties

Aliases

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 323be8719..0a2bd2111 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

Description: string
+

Hierarchy

Index

Properties

Properties

Description

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 50e22d47b..7534e3c4e 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

Interface IHasDisplay

Interface for items with rendering information.

-

Hierarchy

Index

Properties

Properties

Display

Display: IDisplay
+

Hierarchy

Index

Properties

Properties

Display

Display: IDisplay

Data relevant to this item's display/rendering.

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 9e2cd1778..126485a1a 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

Game objects: IGameObject[]
+

Hierarchy

  • IHasGameObjects

Index

Properties

Properties

Game objects

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 c9f9bc601..c36345665 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

Interface IHasId

For elements with unique string IDs.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string

The item's unique string ID.

pattern

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

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 3f0425888..183e5639b 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 IHasName

Interface for items with a Name key.

-

Hierarchy

Index

Properties

Properties

Name

Name: string
+

Hierarchy

Index

Properties

Properties

Name

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 8af01f700..0a3c2ad56 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

Interface IHasOptional

Hierarchy

Index

Properties

Properties

Optional

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

Interface IHasOptional

Hierarchy

Index

Properties

Properties

Optional

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 1e937695d..30bdeea96 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

Content

Content: IOracleContent
+

Hierarchy

  • IHasOracleContent

Index

Properties

Properties

Content

Content: IOracleContent

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 04f97a541..91fa342f4 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

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

Interface IHasQuestStarter

Hierarchy

Index

Properties

Properties

Quest Starter

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 810d6293d..334de1190 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

Requires: IRequirements
+

Hierarchy

  • IHasRequirements

Index

Properties

Properties

Requires

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 ec61d5d08..48406aa21 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

Roll template: IRollTemplate
+

Hierarchy

  • IHasRollTemplate

Index

Properties

Properties

Roll template

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 bea2081f2..5ff3370b9 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

Interface IHasSource

Interface for items with sourcing information.

-

Hierarchy

Index

Properties

Properties

Source

Source: ISource
+

Hierarchy

Index

Properties

Properties

Source

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 diff --git a/docs/interfaces/Json_Meta.IHasSubtable.html b/docs/interfaces/Json_Meta.IHasSubtable.html index dfba83978..579915ab4 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 IHasSubtable

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

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

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 9d66cc9e8..c5caac2f3 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

Suggestions: ISuggestions
+

Hierarchy

  • IHasSuggestions

Index

Properties

Properties

Suggestions

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 5cef6e134..6c57ad821 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 IHasSummary

Interface for items with a user-facing markdown summary.

-

Hierarchy

Index

Properties

Properties

Summary

Summary: string
+

Hierarchy

Index

Properties

Properties

Summary

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 7104bead2..399570190 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 IHasTable

Interface for items that have a table-like object.

-

Hierarchy

Index

Properties

Properties

Table

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

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 81ef66050..700791786 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

Interface IHasTags

Hierarchy

  • IHasTags

Index

Properties

Properties

Tags

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

Interface IHasTags

Hierarchy

  • IHasTags

Index

Properties

Properties

Tags

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 ad0ae9bde..82ff8e00a 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 IHasText

Interface for items that reproduce Starforged rules text in markdown.

-

Hierarchy

Index

Properties

Properties

Text

Text: string
+

Hierarchy

Index

Properties

Properties

Text

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 467bb210e..d401c7ba7 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

Attributes: IAttributeChoices[]
+

Hierarchy

  • IRequirements

Index

Properties

Properties

Attributes

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 988d313a9..37203b7b1 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 ISource

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

Properties

Authors

Authors: string[]
+

Hierarchy

  • ISource

Index

Properties

Properties

Authors

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"]

-

Optional Date

Date?: string
+

Optional Date

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

-

Optional Page

Page?: number
+

Optional Page

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

Title: string
+

Title

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

-

Optional Url

Url?: string
+

Optional Url

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 27629af34..0c3246687 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

Properties

Optional Assets

Assets?: string[]
+

Hierarchy

  • ISuggestions

Index

Properties

Properties

Optional Assets

Assets?: string[]

Suggested asset IDs.

-

Optional Encounters

Encounters?: string[]
+

Optional Encounters

Encounters?: string[]

Suggested encounter IDs.

-

Optional Game objects

Game objects?: IGameObject[]
+

Optional Game objects

Game objects?: IGameObject[]

Suggested game objects and their parameters.

-

Optional Moves

Moves?: string[]
+

Optional Moves

Moves?: string[]

Suggested move IDs.

-

Optional Oracle rolls

Oracle rolls?: string[]
+

Optional Oracle rolls

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 70d5a4928..0b40127c2 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 IMove

Interface representing a Starforged move.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Moves/Adventure/Face_Danger"

+

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Moves/Adventure/Face_Danger"

pattern

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

-

Optional Asset

Asset?: string
+

Optional Asset

Asset?: string

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

-

Category

Category: string
+

Category

Category: string

The ID of the move's category.

example

"Starforged/Moves/Adventure"

-

Display

Display: IDisplayWithTitle
+

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Name

Name: string
example

"Face Danger"

-

Optional

Optional: boolean
+

Name

Name: string
example

"Face Danger"

+

Optional

Optional: boolean

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

default

false

-

Optional Oracles

Oracles?: string[]
+

Optional Oracles

Oracles?: string[]

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

-

Optional Outcomes

Outcomes?: IMoveOutcomes
+

Optional Outcomes

Outcomes?: IMoveOutcomes

Outcome information for the move.

-

Optional Progress Move

Progress Move?: boolean
+

Optional Progress Move

Progress Move?: boolean

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

-

Source

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Optional Suggestions

Suggestions?: ISuggestions
+

Optional Suggestions

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.

-

Optional Tags

Tags?: string[]

Text

Text: string
+

Optional Tags

Tags?: string[]

Text

Text: string

The item's rules text as a markdown string.

-
markdown

Trigger

Trigger: IMoveTrigger
+
markdown

Trigger

Trigger: IMoveTrigger

The move's trigger data.

-

Optional Variant of

Variant of?: string
+

Optional Variant of

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 dbba87d74..31cceb890 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

Interface IMoveCategory

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

Properties

$id

$id: string
example

"Starforged/Moves/Adventure"

+

Hierarchy

Index

Properties

Properties

$id

$id: string
example

"Starforged/Moves/Adventure"

pattern

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

-

Description

Description: string
+

Description

Description: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Moves

Moves: IMove[]

Name

Name: string
example

"Adventure"

-

Optional

Optional: boolean
+

Moves

Moves: IMove[]

Name

Name: string
example

"Adventure"

+

Optional

Optional: boolean

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

default

false

-

Source

Source: ISource
+

Source

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 1b82f6394..2b377aa98 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

Interface IMoveOutcomes

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Miss

Miss: IOutcomeInfo

Strong Hit

Strong Hit: IOutcomeInfo

Weak Hit

Weak Hit: IOutcomeInfo

Generated using TypeDoc

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

Interface IMoveOutcomes

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Miss

Miss: IOutcomeInfo

Strong Hit

Strong Hit: IOutcomeInfo

Weak Hit

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 fff9fd4f9..f87961172 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

Interface IMoveReroll

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

Dice

Dice: RerollType
+

Hierarchy

Index

Properties

Properties

Dice

Dice: RerollType

The dice to be rerolled.

-

Text

Text: string
+

Text

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 f114d8532..e7e95cc0f 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

Interface IMoveTrigger

Describes the trigger conditions of the move.

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Optional By

By?: IMoveTriggerBy
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional By

By?: IMoveTriggerBy

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.

-

Optional Options

Options?: (IMoveTriggerOptionAction | IMoveTriggerOptionProgress)[]
+

Optional Options

Options?: (IMoveTriggerOptionAction | IMoveTriggerOptionProgress)[]

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.

-

Optional Text

Text?: string
+

Optional Text

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 f0aae37b8..5a329bf03 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

Interface IMoveTriggerBy

Hierarchy

  • IMoveTriggerBy

Index

Properties

Properties

Ally

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

Interface IMoveTriggerBy

Hierarchy

  • IMoveTriggerBy

Index

Properties

Properties

Ally

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

Player: boolean
+

Player

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 94a246093..da73cc949 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

Properties

$id

$id: string
pattern

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

-

Optional Custom stat

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

Interface IMoveTriggerOptionAction

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Custom stat

Custom stat?: ICustomStat

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

-

Method

Method: RollMethod
+

Method

Method: RollMethod

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

-

Roll type

Roll type: Action
+

Roll type

Roll type: Action

Whether this option is an action roll or progress roll.

-

Optional Text

Text?: string
+

Optional Text

Text?: string

The item's rules text as a markdown string.

-
markdown

Using

Using: string[]
+
markdown

Using

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 66f62a12e..2851bd57c 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

Properties

$id

$id: string
pattern

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

-

Optional Custom stat

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

Interface IMoveTriggerOptionBase

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Custom stat

Custom stat?: ICustomStat

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

-

Method

Method: RollMethod
+

Method

Method: RollMethod

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

-

Roll type

Roll type: RollType
+

Roll type

Roll type: RollType

Whether this option is an action roll or progress roll.

-

Optional Text

Text?: string
+

Optional Text

Text?: string

The item's rules text as a markdown string.

-
markdown

Using

Using: string[]
+
markdown

Using

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 d0c771228..640266681 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

Properties

$id

$id: string
pattern

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

-

Optional Custom stat

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

Interface IMoveTriggerOptionProgress

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Custom stat

Custom stat?: ICustomStat

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

-

Method

Method: RollMethod
+

Method

Method: RollMethod

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

-

Roll type

Roll type: Progress
+

Roll type

Roll type: Progress

Whether this option is an action roll or progress roll.

-

Optional Text

Text?: string
+

Optional Text

Text?: string

The item's rules text as a markdown string.

-
markdown

Using

Using: (ProgressTypeStarforged | ProgressTypeIronsworn)[]
+
markdown

Using

Using: (ProgressTypeStarforged | ProgressTypeIronsworn)[]

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 76d4d82f3..edbb46fef 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

Interface IOutcomeInfo

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Optional Count as

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

Interface IOutcomeInfo

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Count as

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

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

-

Optional In Control

In Control?: boolean
+

Optional In Control

In Control?: boolean

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

-

Optional Reroll

Reroll?: IMoveReroll
+

Optional Reroll

Reroll?: IMoveReroll

Information on rerolls offered by this move.

-

Text

Text: string
+

Text

Text: string

The item's rules text as a markdown string.

-
markdown

Optional With a Match

With a Match?: IOutcomeInfo
+
markdown

Optional With a Match

With a Match?: IOutcomeInfo

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

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 65fdacddc..49d7e1619 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

Interface IDisplayOracle

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

Properties

Optional Color

Color?: string
+

Hierarchy

Index

Properties

Properties

Optional Color

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

-

Optional Column of

Column of?: string
+

Optional Column of

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.

-

Optional Embed in

Embed in?: null | string
+

Optional Embed in

Embed in?: null | string

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

-

Optional Icon

Icon?: string
+

Optional Icon

Icon?: string

A URL pointing to a single SVG icon.

pattern

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

-

Optional Images

Images?: string[]
+

Optional Images

Images?: string[]

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

pattern

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

-

Table

Table: ITableDisplayInfo
+

Table

Table: ITableDisplayInfo

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

Title: string
+

Title

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 bc9ce98ad..da36d519d 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

Interface IMultipleRolls

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

-

Hierarchy

  • IMultipleRolls

Index

Properties

Properties

Allow duplicates

Allow duplicates: boolean
+

Hierarchy

  • IMultipleRolls

Index

Properties

Properties

Allow duplicates

Allow duplicates: boolean

Whether to allow duplicate results when generating multiple rolls.

Implicitly required by Make it worse.

-

Amount

Amount: number
+

Amount

Amount: number

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

-

Make it worse

Make it worse: boolean
+

Make it worse

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 24ad49c71..48de02fef 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

Interface IOracle

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

Properties

$id

$id: string
pattern

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

-

Optional Aliases

Aliases?: string[]
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Aliases

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

Category: string
+

Category

Category: string

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

-

Optional Content

Content?: IOracleContent
+

Optional Content

Content?: IOracleContent

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

-

Optional Description

Description?: string
+

Optional Description

Description?: string

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

-
markdown

Display

Display: IDisplayOracle
+
markdown

Display

Display: IDisplayOracle

Data relevant to this item's display/rendering.

-

Optional Member of

Member of?: string
+

Optional Member of

Member of?: string

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

-

Name

Name: string
+

Name

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.

-

Optional Oracles

Oracles?: IOracle[]
+

Optional Oracles

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

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Optional Table

Table?: IRow[]
+

Optional Table

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.

-

Optional Usage

Usage?: IOracleUsage
+

Optional Usage

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 36c677e0d..0fb36cb30 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

Properties

$id

$id: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string

The item's unique string ID.

pattern

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

-

Optional Aliases

Aliases?: string[]
+

Optional Aliases

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.

-

Optional Categories

Categories?: IOracleCategory[]
+

Optional Categories

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.

-

Optional Category

Category?: string
+

Optional Category

Category?: string

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

pattern

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

-

Optional Content

Content?: IOracleContent
+

Optional Content

Content?: IOracleContent

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

-

Optional Description

Description?: string
+

Optional Description

Description?: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Optional Member of

Member of?: string
+

Optional Member of

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

Name: string
+

Name

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.

-

Optional Oracles

Oracles?: IOracle[]
+

Optional Oracles

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

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Optional Table

Table?: IRow[]
+

Optional Table

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.

-

Optional Usage

Usage?: IOracleUsage
+

Optional Usage

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 6da27d9e2..9e167bafc 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

Interface IOracleCategory

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

Properties

$id

$id: string
pattern

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

-

Optional Aliases

Aliases?: string[]
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Optional Aliases

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.

-

Optional Categories

Categories?: IOracleCategory[]
+

Optional Categories

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.

-

Optional Category

Category?: string

Optional Content

Content?: IOracleContent
+

Optional Category

Category?: string

Optional Content

Content?: IOracleContent

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

-

Optional Description

Description?: string
+

Optional Description

Description?: string

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

-
markdown

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Optional Member of

Member of?: string
+

Optional Member of

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

Name: string
+

Name

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.

-

Optional Oracles

Oracles?: IOracle[]
+

Optional Oracles

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

-

Optional Sample Names

Sample Names?: string[]
+

Optional Sample Names

Sample Names?: string[]

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

-

Source

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Optional Usage

Usage?: IOracleUsage
+

Optional Usage

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 376bfd1bd..4ded4acba 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 IOracleContent

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

-

Hierarchy

  • IOracleContent

Index

Properties

Properties

Optional Part of speech

Part of speech?: PartOfSpeechTag[]
+

Hierarchy

  • IOracleContent

Index

Properties

Properties

Optional Part of speech

Part of speech?: PartOfSpeechTag[]

The part of speech of this oracle.

-

Optional Tags

Tags?: string[]
+

Optional Tags

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 59553e2cb..9512a8338 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

Interface IOracleUsage

Describes the recommended usage of this item.

-

Hierarchy

Index

Properties

Properties

Optional Allow duplicates

Allow duplicates?: boolean
+

Hierarchy

Index

Properties

Properties

Optional Allow duplicates

Allow duplicates?: boolean

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

-

Optional Initial

Initial?: boolean
+

Optional Initial

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.

-

Optional Max rolls

Max rolls?: number
+

Optional Max rolls

Max rolls?: number

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

-

Optional Min rolls

Min rolls?: number
+

Optional Min rolls

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.

-

Optional Repeatable

Repeatable?: boolean
+

Optional Repeatable

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.

-

Optional Requires

Requires?: IRequirements

Optional Roll template

Roll template?: IRollTemplate
+

Optional Requires

Requires?: IRequirements

Optional Roll template

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.

-

Optional Sets

Sets?: IAttributeChoices[]
+

Optional Sets

Sets?: IAttributeChoices[]

Hints which attributes are set by this table.

-

Optional Suggestions

Suggestions?: ISuggestions

Generated using TypeDoc

\ No newline at end of file +

Optional Suggestions

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 485f49cfd..2d98609ad 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

Interface IRollColumn

Hierarchy

Index

Properties

Properties

Label

Label: string

Use content from

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

Interface IRollColumn

Hierarchy

Index

Properties

Properties

Label

Label: string

Use content from

Use content from: string

The ID of the oracle table to use.

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 1d810933f..a197dcb87 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

Interface IRollTemplate

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

Properties

Optional Description

Description?: string
+

Hierarchy

  • IRollTemplate

Index

Properties

Properties

Optional Description

Description?: string

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

-

Optional Result

Result?: string
+

Optional Result

Result?: string

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

-

Optional Summary

Summary?: string
+

Optional Summary

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 72ed3cdac..50ef050b4 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 IRow

Interface representing a single row in an oracle table.

-

Hierarchy

Index

Properties

Properties

Optional $id

$id?: null | string
+

Hierarchy

Index

Properties

Properties

Optional $id

$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

Optional Attributes

Attributes?: IAttribute[]
+
nullable

Optional Attributes

Attributes?: IAttribute[]

The attributes set by this row.

-

Ceiling

Ceiling: null | number
+

Ceiling

Ceiling: null | number

The high end of the dice range for this row.

minimum

1

maximum

100

-
nullable

Optional Content

Content?: IOracleContent
+
nullable

Optional Content

Content?: IOracleContent

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

-

Optional Display

Display?: IDisplay
+

Optional Display

Display?: IDisplay

Data relevant to this item's display/rendering.

-

Floor

Floor: null | number
+

Floor

Floor: null | number

The low end of the dice range for this row.

minimum

1

maximum

100

-
nullable

Optional Game objects

Game objects?: IGameObject[]
+
nullable

Optional Game objects

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.

-

Optional Multiple rolls

Multiple rolls?: IMultipleRolls
+

Optional Multiple rolls

Multiple rolls?: IMultipleRolls

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

-

Optional Oracle rolls

Oracle rolls?: string[]
+

Optional Oracle rolls

Oracle rolls?: string[]

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

-

Result

Result: string
+

Result

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.

-

Optional Roll template

Roll template?: IRollTemplate
+

Optional Roll template

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.

-

Optional Subtable

Subtable?: IRow[]
+

Optional Subtable

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.

-

Optional Suggestions

Suggestions?: ISuggestions
+

Optional Suggestions

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.

-

Optional Summary

Summary?: null | string
+

Optional Summary

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 6f1314e1e..113065944 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 ITableColumnBase

Interface with elements common to IRollColumn and ITextColumn.

-

Hierarchy

Index

Properties

Properties

Label

Label: string

Use content from

Use content from: string
+

Hierarchy

Index

Properties

Properties

Label

Label: string

Use content from

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 6555bff51..b69b4cb3f 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

Interface ITableDisplayInfo

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

-

Hierarchy

  • ITableDisplayInfo

Index

Properties

Properties

Result columns

Result columns: ITextColumn[]

Roll columns

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

Properties

Result columns

Result columns: ITextColumn[]

Roll columns

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 593ce9795..824ddefac 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

Interface ITextColumn

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

-

Hierarchy

Index

Properties

Properties

Key

Key: "Summary" | "Result"
+

Hierarchy

Index

Properties

Properties

Key

Key: "Summary" | "Result"

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

-

Label

Label: string
+

Label

Label: string

The label or header text to use for this column.

-

Use content from

Use content from: string
+

Use content from

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 b082c7d6c..cc321b0df 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 ISettingTruth

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

see

ISettingTruthOption

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

-

Character

Character: string
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

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

+

Character

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

Display

Display: IDisplayWithTitle
+
markdown

Display

Display: IDisplayWithTitle

Data relevant to this item's display/rendering.

-

Name

Name: string
+

Name

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

Source: ISource
+

Source

Source: ISource

Information on this item's source.

-

Optional Suggestions

Suggestions?: ISuggestions
+

Optional Suggestions

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.

-

Table

Table: ISettingTruthOption[]
+

Table

Table: ISettingTruthOption[]

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 c08d9503d..9069a4837 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 ISettingTruthOption

Interface for 'canonical' options within a SettingTruth category.

see

ISettingTruth

-

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

^(Starforged|Ironsworn)/Setting_Truths/[A-z_-]+/(1-33|34-67|68-100|[1-3])$

-

Optional Attributes

Attributes?: IAttribute[]
+

Hierarchy

Index

Properties

Properties

$id

$id: string
pattern

^(Starforged|Ironsworn)/Setting_Truths/[A-z_-]+/(1-33|34-67|68-100|[1-3])$

+

Optional Attributes

Attributes?: IAttribute[]

The attributes set by this row.

-

Ceiling

Ceiling: null | number
+

Ceiling

Ceiling: null | number

The high end of the dice range for this row.

minimum

1

maximum

100

-
nullable

Optional Content

Content?: IOracleContent
+
nullable

Optional Content

Content?: IOracleContent

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

-

Description

Description: string
+

Description

Description: string

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

-
markdown

Optional Display

Display?: IDisplay
+
markdown

Optional Display

Display?: IDisplay

Data relevant to this item's display/rendering.

-

Floor

Floor: null | number
+

Floor

Floor: null | number

The low end of the dice range for this row.

minimum

1

maximum

100

-
nullable

Optional Game objects

Game objects?: IGameObject[]
+
nullable

Optional Game objects

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.

-

Optional Multiple rolls

Multiple rolls?: IMultipleRolls
+

Optional Multiple rolls

Multiple rolls?: IMultipleRolls

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

-

Optional Oracle rolls

Oracle rolls?: string[]
+

Optional Oracle rolls

Oracle rolls?: string[]

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

-

Quest Starter

Quest Starter: string
+

Quest Starter

Quest Starter: string

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

-
markdown

Result

Result: string
+
markdown

Result

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.

-

Optional Roll template

Roll template?: IRollTemplate
+

Optional Roll template

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.

-

Optional Subtable

Subtable?: IRow[]
+

Optional Subtable

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.

-

Optional Suggestions

Suggestions?: ISuggestions
+

Optional Suggestions

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.

-

Optional Summary

Summary?: null | string
+

Optional Summary

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 d043570bd..67c4c6434 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

Interface ISettingTruthOptionSubtableRow

Hierarchy

  • IRow
    • ISettingTruthOptionSubtableRow

Index

Properties

Properties

$id

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

-

Optional Attributes

Attributes?: IAttribute[]
+ISettingTruthOptionSubtableRow | Dataforged API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ISettingTruthOptionSubtableRow

Hierarchy

  • IRow
    • ISettingTruthOptionSubtableRow

Index

Properties

Properties

$id

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

+

Optional Attributes

Attributes?: IAttribute[]

The attributes set by this row.

-

Ceiling

Ceiling: null | number
+

Ceiling

Ceiling: null | number

The high end of the dice range for this row.

minimum

1

maximum

100

-
nullable

Optional Content

Content?: IOracleContent
+
nullable

Optional Content

Content?: IOracleContent

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

-

Optional Display

Display?: IDisplay
+

Optional Display

Display?: IDisplay

Data relevant to this item's display/rendering.

-

Floor

Floor: null | number
+

Floor

Floor: null | number

The low end of the dice range for this row.

minimum

1

maximum

100

-
nullable

Optional Game objects

Game objects?: IGameObject[]
+
nullable

Optional Game objects

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.

-

Optional Multiple rolls

Multiple rolls?: IMultipleRolls
+

Optional Multiple rolls

Multiple rolls?: IMultipleRolls

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

-

Optional Oracle rolls

Oracle rolls?: string[]
+

Optional Oracle rolls

Oracle rolls?: string[]

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

-

Result

Result: string
+

Result

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.

-

Optional Roll template

Roll template?: IRollTemplate
+

Optional Roll template

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.

-

Optional Subtable

Subtable?: IRow[]
+

Optional Subtable

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.

-

Optional Suggestions

Suggestions?: ISuggestions
+

Optional Suggestions

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.

-

Optional Summary

Summary?: null | string
+

Optional Summary

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 eaa03a559..4abdb565e 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

Types describing asset cards in Ironsworn and Ironsworn: Starforged.

-

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

RequireKey

RequireKey<T, K>: T & { [ P in K]-?: NonNullable<T[P extends keyof T ? P : never]> }
+

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

RequireKey

RequireKey<T, K>: T & { [ P in K]-?: NonNullable<T[P extends keyof T ? P : never]> }

Generic type: require specific keys to be NonNullable.

Type Parameters

  • T

  • K extends keyof any = ""

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 ab8d3fe97..f77404e68 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

Types describing elements common to many Ironsworn: Starforged game objects in Dataforged.

-

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

RollableStat

RollableStat: Stat | ICustomStat["$id"] | PlayerConditionMeter | IConditionMeter["$id"]
+

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

RollableStat

RollableStat: Stat | ICustomStat["$id"] | PlayerConditionMeter | IConditionMeter["$id"]

Standard player character stats or condition meters that can be used as +stat in an action roll.

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 37b53d46a..33c33c809 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

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

AttributeValue

AttributeValue<K>: IAttributeMaster[K]
alpha

Type Parameters

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

Index

Enumerations

Interfaces

Type Aliases

Type Aliases

AttributeValue

AttributeValue<K>: IAttributeMaster[K]
alpha

Type Parameters

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 f141912a0..37e548456 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

Index

Interfaces

Type Aliases

Type Aliases

KeysWithValuesOfType

KeysWithValuesOfType<T, V>: keyof { [ P in keyof Required<T> as Required<T>[P] extends V ? P : never]: P }

Type Parameters

  • T

  • V

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

Index

Interfaces

Type Aliases

Type Aliases

KeysWithValuesOfType

KeysWithValuesOfType<T, V>: keyof { [ P in keyof Required<T> as Required<T>[P] extends V ? P : never]: P }

Type Parameters

  • T

  • V

Legend

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

Settings

Theme

Generated using TypeDoc

\ No newline at end of file