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.
19 lines • 13.3 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ISource | 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="../modules/Json_Meta.html">Json.Meta</a></li><li><a href="Json_Meta.ISource.html">ISource</a></li></ul><h1>Interface ISource </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>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.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">ISource</span></li></ul></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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Authors" class="tsd-kind-icon">Authors</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Date" class="tsd-kind-icon">Date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Page" class="tsd-kind-icon">Page</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Title" class="tsd-kind-icon">Title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Url" class="tsd-kind-icon">Url</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Authors" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Authors<a href="#Authors" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Authors<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/ISource.ts#L48">json_out/meta/ISource.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>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.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>["Shawn Tomkin"]</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Date" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Date<a href="#Date" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Date<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/ISource.ts#L53">json_out/meta/ISource.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The 6-number date string formatted as <code>MMDDYY</code>. Relevant only during Starforged development; it will be deprecated once the game is released.</p>
</div><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^(0[1-9]|1[0-2])([0-2][1-9]|3[0-1])([0-9][0-9])$</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Page" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Page<a href="#Page" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Page<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/ISource.ts#L57">json_out/meta/ISource.ts:57</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The page on which the item appears most prominently in the source material (if it's in a format that uses page numbers).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Title" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Title<a href="#Title" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/ISource.ts#L43">json_out/meta/ISource.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The title of the source.</p>
</div><div><p>For 'canonical' content, use one of the enumerated <code>SourceTitle</code> strings.</p>
<p>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").</p>
<p>If the source has no particular title (for instance, it's a single custom element in a VTT implementation), use "Custom".</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Url<a href="#Url" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/ISource.ts#L62">json_out/meta/ISource.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The URL where the source material is available.</p>
</div><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^https?://.*$</p>
</dd></dl></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="../modules/Json_Assets.html">Json.<wbr/>Assets</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Common.html">Json.<wbr/>Common</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Cyclopedia.html">Json.<wbr/>Cyclopedia</a></li><li class=" tsd-kind-module"><a href="../modules/Json_GameObjects.html">Json.<wbr/>Game<wbr/>Objects</a></li><li class="current tsd-kind-module"><a href="../modules/Json_Meta.html">Json.<wbr/>Meta</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Moves.html">Json.<wbr/>Moves</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Oracles.html">Json.<wbr/>Oracles</a></li><li class=" tsd-kind-module"><a href="../modules/Json_SettingTruths.html">Json.<wbr/>Setting<wbr/>Truths</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="Json_Meta.ISource.html" class="tsd-kind-icon">ISource</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Authors" class="tsd-kind-icon">Authors</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Date" class="tsd-kind-icon">Date</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Page" class="tsd-kind-icon">Page</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Title" class="tsd-kind-icon">Title</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Meta.ISource.html#Url" class="tsd-kind-icon">Url</a></li></ul></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-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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>