UNPKG

dataforged

Version:

Official content and rules data for the Ironsworn: Starforged tabletop role-playing game, formatted as JSON for use in community tools. 🚀 Includes JSON schemas and a Javascript/Typescript API.

3 lines • 8.38 kB
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Json.Cyclopedia | Dataforged API</title><meta name="description" content="Documentation for Dataforged API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Dataforged API</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Dataforged API</a></li><li><a href="Json_Cyclopedia.html">Json.Cyclopedia</a></li></ul><h1>Module Json.Cyclopedia </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead"> <p>Types describing &quot;cyclopedia&quot;-style entries, such as Regions (in <em>Ironsworn</em>) and Encounters.</p> </div></div></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/Json_Cyclopedia.EncounterNatureIronsworn.html" class="tsd-kind-icon">Encounter<wbr/>Nature<wbr/>Ironsworn</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/Json_Cyclopedia.EncounterNatureStarforged.html" class="tsd-kind-icon">Encounter<wbr/>Nature<wbr/>Starforged</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/Json_Cyclopedia.EncounterTags.html" class="tsd-kind-icon">Encounter<wbr/>Tags</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.ICyclopediaEntry.html" class="tsd-kind-icon">ICyclopedia<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounter.html" class="tsd-kind-icon">IEncounter</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterBase.html" class="tsd-kind-icon">IEncounter<wbr/>Base</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterIronsworn.html" class="tsd-kind-icon">IEncounter<wbr/>Ironsworn</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterNatureInfo.html" class="tsd-kind-icon">IEncounter<wbr/>Nature<wbr/>Info</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterStarforged.html" class="tsd-kind-icon">IEncounter<wbr/>Starforged</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterVariant.html" class="tsd-kind-icon">IEncounter<wbr/>Variant</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IIronswornRegion.html" class="tsd-kind-icon">IIronsworn<wbr/>Region</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="Json_Assets.html">Json.<wbr/>Assets</a></li><li class=" tsd-kind-module"><a href="Json_Common.html">Json.<wbr/>Common</a></li><li class="current tsd-kind-module"><a href="Json_Cyclopedia.html">Json.<wbr/>Cyclopedia</a></li><li class=" tsd-kind-module"><a href="Json_GameObjects.html">Json.<wbr/>Game<wbr/>Objects</a></li><li class=" tsd-kind-module"><a href="Json_Meta.html">Json.<wbr/>Meta</a></li><li class=" tsd-kind-module"><a href="Json_Moves.html">Json.<wbr/>Moves</a></li><li class=" tsd-kind-module"><a href="Json_Oracles.html">Json.<wbr/>Oracles</a></li><li class=" tsd-kind-module"><a href="Json_SettingTruths.html">Json.<wbr/>Setting<wbr/>Truths</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/Json_Cyclopedia.EncounterNatureIronsworn.html" class="tsd-kind-icon">Encounter<wbr/>Nature<wbr/>Ironsworn</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/Json_Cyclopedia.EncounterNatureStarforged.html" class="tsd-kind-icon">Encounter<wbr/>Nature<wbr/>Starforged</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/Json_Cyclopedia.EncounterTags.html" class="tsd-kind-icon">Encounter<wbr/>Tags</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.ICyclopediaEntry.html" class="tsd-kind-icon">ICyclopedia<wbr/>Entry</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounter.html" class="tsd-kind-icon">IEncounter</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterBase.html" class="tsd-kind-icon">IEncounter<wbr/>Base</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterIronsworn.html" class="tsd-kind-icon">IEncounter<wbr/>Ironsworn</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterNatureInfo.html" class="tsd-kind-icon">IEncounter<wbr/>Nature<wbr/>Info</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterStarforged.html" class="tsd-kind-icon">IEncounter<wbr/>Starforged</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IEncounterVariant.html" class="tsd-kind-icon">IEncounter<wbr/>Variant</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/Json_Cyclopedia.IIronswornRegion.html" class="tsd-kind-icon">IIronsworn<wbr/>Region</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>