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.
41 lines • 30.6 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IRow | 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_Oracles.html">Json.Oracles</a></li><li><a href="Json_Oracles.IRow.html">IRow</a></li></ul><h1>Interface IRow </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 a single row in an oracle table.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol"><</span><a href="Json_Meta.IHasSummary.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasSummary</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><a href="Json_Meta.IHasRollTemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasRollTemplate</a><span class="tsd-signature-symbol"> & </span><a href="Json_Meta.IHasSuggestions.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasSuggestions</a><span class="tsd-signature-symbol"> & </span><a href="Json_Meta.IHasOracleContent.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasOracleContent</a><span class="tsd-signature-symbol"> & </span><a href="Json_Meta.IHasGameObjects.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasGameObjects</a><span class="tsd-signature-symbol"> & </span><a href="Json_Meta.IHasDisplay.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasDisplay</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IRow</span><ul class="tsd-hierarchy"><li><a href="Json_SettingTruths.ISettingTruthOption.html" class="tsd-signature-type" data-tsd-kind="Interface">ISettingTruthOption</a></li><li><a href="Json_SettingTruths.ISettingTruthOptionSubtableRow.html" class="tsd-signature-type" data-tsd-kind="Interface">ISettingTruthOptionSubtableRow</a></li></ul></li></ul></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_Oracles.IRow.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Attributes" class="tsd-kind-icon">Attributes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Ceiling" class="tsd-kind-icon">Ceiling</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Content" class="tsd-kind-icon">Content</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Floor" class="tsd-kind-icon">Floor</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Game_objects" class="tsd-kind-icon">Game objects</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Multiple_rolls" class="tsd-kind-icon">Multiple rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Oracle_rolls" class="tsd-kind-icon">Oracle rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Result" class="tsd-kind-icon">Result</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Roll_template" class="tsd-kind-icon">Roll template</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Subtable" class="tsd-kind-icon">Subtable</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Suggestions" class="tsd-kind-icon">Suggestions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IRow.html#Summary" class="tsd-kind-icon">Summary</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="_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> $id<a href="#_id" 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">$id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><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/oracles/IRow.ts#L21">json_out/oracles/IRow.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ID of this row.</p>
</div><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^(Ironsworn|Starforged)/Oracles(/[A-z_-]+)+/[1-9][0-9]<em>(-[1-9][0-9]</em>)?(/Subtable/[1-9][0-9]<em>(-[1-9][0-9]</em>)?)?$</p>
</dd><dt>nullable</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Attributes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Attributes<a href="#Attributes" 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">Attributes<span class="tsd-signature-symbol">?:</span> <a href="Json_GameObjects.IAttribute.html" class="tsd-signature-type" data-tsd-kind="Interface">IAttribute</a><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/oracles/IRow.ts#L68">json_out/oracles/IRow.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The attributes set by this row.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Ceiling" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Ceiling<a href="#Ceiling" 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">Ceiling<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><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/oracles/IRow.ts#L35">json_out/oracles/IRow.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The high end of the dice range for this row.</p>
</div><dl class="tsd-comment-tags"><dt>minimum</dt><dd><p>1</p>
</dd><dt>maximum</dt><dd><p>100</p>
</dd><dt>nullable</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Content" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Content<a href="#Content" 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">Content<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IOracleContent.html" class="tsd-signature-type" data-tsd-kind="Interface">IOracleContent</a></div><aside class="tsd-sources"><p>Inherited from Partial.Content</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L128">json_out/meta/IHas.ts:128</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Metadata that describes an oracle's semantic or lexical content.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Display" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Display<a href="#Display" 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">Display<span class="tsd-signature-symbol">?:</span> <a href="Json_Meta.IDisplay.html" class="tsd-signature-type" data-tsd-kind="Interface">IDisplay</a></div><aside class="tsd-sources"><p>Inherited from Partial.Display</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L83">json_out/meta/IHas.ts:83</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Data relevant to this item's display/rendering.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Floor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Floor<a href="#Floor" 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">Floor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><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/oracles/IRow.ts#L28">json_out/oracles/IRow.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The low end of the dice range for this row.</p>
</div><dl class="tsd-comment-tags"><dt>minimum</dt><dd><p>1</p>
</dd><dt>maximum</dt><dd><p>100</p>
</dd><dt>nullable</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Game_objects" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Game objects<a href="#Game_objects" 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">Game objects<span class="tsd-signature-symbol">?:</span> <a href="Json_GameObjects.IGameObject.html" class="tsd-signature-type" data-tsd-kind="Interface">IGameObject</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from Partial.Game objects</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L167">json_out/meta/IHas.ts:167</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Any game objects that are explicitly pointed to by the original text. For most implementations, it is <em>not</em> recommended to generate them automatically - see "Peeling the Onion", p. 293.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Multiple_rolls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Multiple rolls<a href="#Multiple_rolls" 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">Multiple rolls<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IMultipleRolls.html" class="tsd-signature-type" data-tsd-kind="Interface">IMultipleRolls</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/oracles/IRow.ts#L64">json_out/oracles/IRow.ts:64</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Data for rows that call for multiple rolls, e.g. on <code>Roll twice</code> results.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Oracle_rolls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Oracle rolls<a href="#Oracle_rolls" 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">Oracle rolls<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/oracles/IRow.ts#L56">json_out/oracles/IRow.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Additional oracle tables that should be rolled when this row is selected.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Result" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Result<a href="#Result" 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">Result<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/oracles/IRow.ts#L41">json_out/oracles/IRow.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>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.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Roll_template" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Roll template<a href="#Roll_template" 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">Roll template<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IRollTemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">IRollTemplate</a></div><aside class="tsd-sources"><p>Inherited from Partial.Roll template</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L117">json_out/meta/IHas.ts:117</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>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.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Subtable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Subtable<a href="#Subtable" 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">Subtable<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IRow.html" class="tsd-signature-type" data-tsd-kind="Interface">IRow</a><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/oracles/IRow.ts#L60">json_out/oracles/IRow.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A table to be rolled when this row is selected. If this row references an external oracle, the <code>Oracles</code> property is used instead.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Suggestions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Suggestions<a href="#Suggestions" 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">Suggestions<span class="tsd-signature-symbol">?:</span> <a href="Json_Meta.ISuggestions.html" class="tsd-signature-type" data-tsd-kind="Interface">ISuggestions</a></div><aside class="tsd-sources"><p>Inherited from Partial.Suggestions</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L106">json_out/meta/IHas.ts:106</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>"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.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="Summary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Summary<a href="#Summary" 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">Summary<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Overrides Partial.Summary</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/oracles/IRow.ts#L52">json_out/oracles/IRow.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>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).</p>
</div><div><p>Generally, <code>Summary</code> is longer than <code>Result</code>.</p>
<p>Some tables label this column as something other than <code>Result</code>; see the parent (or grandparent) <code>IOracle.Display.Table</code> for more information.</p>
<p><code>null</code> is used in cases where an 'empty' <code>Summary</code> exists (example: Starship Type, p. 326). In the book, these table cells are rendered with the text <code>--</code> (and this is the recommended placeholder for tabular display). For display as a single result (e.g. VTT table roll output), however, <code>null</code> values can be safely omitted.</p>
</div><dl class="tsd-comment-tags"><dt>nullable</dt><dd></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=" 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="current 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_Oracles.IRow.html" class="tsd-kind-icon">IRow</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Attributes" class="tsd-kind-icon">Attributes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Ceiling" class="tsd-kind-icon">Ceiling</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Content" class="tsd-kind-icon">Content</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Floor" class="tsd-kind-icon">Floor</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Game_objects" class="tsd-kind-icon">Game objects</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Multiple_rolls" class="tsd-kind-icon">Multiple rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Oracle_rolls" class="tsd-kind-icon">Oracle rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Result" class="tsd-kind-icon">Result</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Roll_template" class="tsd-kind-icon">Roll template</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IRow.html#Subtable" class="tsd-kind-icon">Subtable</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IRow.html#Suggestions" class="tsd-kind-icon">Suggestions</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IRow.html#Summary" class="tsd-kind-icon">Summary</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>