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.9 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IOracleBase | 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.IOracleBase.html">IOracleBase</a></li></ul><h1>Interface IOracleBase </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 with elements common to various Oracle-related interfaces and classes.</p>
</div><div><p>If you're trying to crawl the tree for a specific ID, I'd recommend using some flavour of JSONpath (I like <code>jsonpath-plus</code>) - it's purpose-made for this sort of nested data structure.</p>
<p>But if for some reason you can't, you can use this interface to type both <a href="Json_Oracles.IOracle.html">IOracle</a> and <a href="Json_Oracles.IOracleCategory.html">IOracleCategory</a> as you recurse the oracle hierarchy. Objects with <code>Categories</code> and <code>Oracles</code> are "branches", and objects with <code>Table</code> are "leaves".</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><a href="Json_Meta.IHasAliases.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasAliases</a><span class="tsd-signature-symbol"> & </span><a href="Json_Meta.IHasDescription.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasDescription</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></li><li><a href="Json_Meta.IHasId.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasId</a></li><li><a href="Json_Meta.IHasDisplay.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasDisplay</a></li><li><a href="Json_Meta.IHasSource.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasSource</a></li><li><a href="Json_Meta.IHasName.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasName</a><ul class="tsd-hierarchy"><li><span class="target">IOracleBase</span><ul class="tsd-hierarchy"><li><a href="Json_Oracles.IOracle.html" class="tsd-signature-type" data-tsd-kind="Interface">IOracle</a></li><li><a href="Json_Oracles.IOracleCategory.html" class="tsd-signature-type" data-tsd-kind="Interface">IOracleCategory</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 tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#Aliases" class="tsd-kind-icon">Aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Categories" class="tsd-kind-icon">Categories</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Category" class="tsd-kind-icon">Category</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.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.IOracleBase.html#Description" class="tsd-kind-icon">Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IOracleBase.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Member_of" class="tsd-kind-icon">Member of</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#Name" class="tsd-kind-icon">Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#On_a_Match" class="tsd-kind-icon">On a <wbr/>Match</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Oracles" class="tsd-kind-icon">Oracles</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#Source" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Table" class="tsd-kind-icon">Table</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Usage" class="tsd-kind-icon">Usage</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 tsd-is-inherited"><a id="_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link">$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">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="Json_Meta.IHasId.html">IHasId</a>.<a href="Json_Meta.IHasId.html#_id">$id</a></p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L59">json_out/meta/IHas.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The item's unique string ID.</p>
</div><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^(Starforged|Ironsworn)/[0-9A-z_/-]+$</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Aliases" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Aliases<a href="#Aliases" 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">Aliases<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from Partial.Aliases</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L35">json_out/meta/IHas.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Alternate names for this item, including: names it had earlier in development that have since changed, alternate spellings/punctuation, common misspellings, and so on.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Categories" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Categories<a href="#Categories" 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">Categories<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IOracleCategory.html" class="tsd-signature-type" data-tsd-kind="Interface">IOracleCategory</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/IOracleBase.ts#L59">json_out/oracles/IOracleBase.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Subcategories contained by this oracle category.</p>
</div><div><p>This key appears only on <a href="Json_Oracles.IOracleCategory.html">IOracleCategory</a>, and thus only on 'branch' nodes of the oracle hierarchy 'tree.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Category" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Category<a href="#Category" 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">Category<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/IOracleBase.ts#L31">json_out/oracles/IOracleBase.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ID of the most recent OracleCategory ancestor of this item, if any.</p>
</div><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^(Ironsworn|Starforged)/Oracles/[A-z_-/]+$</p>
</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="Description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Description<a href="#Description" 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">Description<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from Partial.Description</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L24">json_out/meta/IHas.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A user-facing markdown description of the item, consisting of one or more paragraphs.</p>
</div><dl class="tsd-comment-tags"><dt>markdown</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="Display" class="tsd-anchor"></a><h3 class="tsd-anchor-link">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.IDisplayWithTitle.html" class="tsd-signature-type" data-tsd-kind="Interface">IDisplayWithTitle</a></div><aside class="tsd-sources"><p>Overrides <a href="Json_Meta.IHasDisplay.html">IHasDisplay</a>.<a href="Json_Meta.IHasDisplay.html#Display">Display</a></p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/oracles/IOracleBase.ts#L37">json_out/oracles/IOracleBase.ts:37</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="Member_of" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Member of<a href="#Member_of" 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">Member of<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/IOracleBase.ts#L36">json_out/oracles/IOracleBase.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ID of the most recent Oracle ancestor of this item, if any.</p>
</div><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^(Ironsworn|Starforged)/Oracles/[A-z_-]+/[A-z_-]+$</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Name" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Name<a href="#Name" 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">Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="Json_Meta.IHasName.html">IHasName</a>.<a href="Json_Meta.IHasName.html#Name">Name</a></p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L72">json_out/meta/IHas.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>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.</p>
</div><div><p>If the item has Display.Title, that should be preferred for most user-facing labels.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="On_a_Match" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> On a <wbr/>Match<a href="#On_a_Match" 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">On a <wbr/>Match<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IOracleMatch.html" class="tsd-signature-type" data-tsd-kind="Interface">IOracleMatch</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/IOracleBase.ts#L65">json_out/oracles/IOracleBase.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Describes the match behaviour of this oracle's table, if any, and provides a <code>Text</code> string describing it. Only appears on a handful of move oracles like Ask the Oracle and Advance a Threat.</p>
</div><div><p>This key appears only on <a href="Json_Oracles.IOracle.html">IOracle</a>s that have a <code>Table</code>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Oracles" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Oracles<a href="#Oracles" 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">Oracles<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IOracle.html" class="tsd-signature-type" data-tsd-kind="Interface">IOracle</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/IOracleBase.ts#L53">json_out/oracles/IOracleBase.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Oracle objects contained by this object.</p>
</div><div><p>This key appears only on 'branch' nodes of the oracle hierarchy 'tree': <a href="Json_Oracles.IOracleCategory.html">IOracleCategory</a>, and <a href="Json_Oracles.IOracle.html">IOracle</a> (when it contains multiple closely-related tables).</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Source" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Source<a href="#Source" 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">Source<span class="tsd-signature-symbol">:</span> <a href="Json_Meta.ISource.html" class="tsd-signature-type" data-tsd-kind="Interface">ISource</a></div><aside class="tsd-sources"><p>Inherited from <a href="Json_Meta.IHasSource.html">IHasSource</a>.<a href="Json_Meta.IHasSource.html#Source">Source</a></p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L47">json_out/meta/IHas.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on this item's source.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Table" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Table<a href="#Table" 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">Table<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/IOracleBase.ts#L47">json_out/oracles/IOracleBase.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Represents a single oracle table, where 'table' is defined as being something with a single roll range.</p>
</div><div><p>This key appears only on 'leaf' nodes of the oracle hierarchy 'tree' - in other words, many (but not all) <a href="Json_Oracles.IOracle.html">IOracle</a> objects.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Usage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Usage<a href="#Usage" 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">Usage<span class="tsd-signature-symbol">?:</span> <a href="Json_Oracles.IOracleUsage.html" class="tsd-signature-type" data-tsd-kind="Interface">IOracleUsage</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/IOracleBase.ts#L41">json_out/oracles/IOracleBase.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on the usage of this oracle: recommended number of rolls, etc.</p>
</div></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.IOracleBase.html" class="tsd-kind-icon">IOracle<wbr/>Base</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#Aliases" class="tsd-kind-icon">Aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Categories" class="tsd-kind-icon">Categories</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Category" class="tsd-kind-icon">Category</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.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.IOracleBase.html#Description" class="tsd-kind-icon">Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IOracleBase.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Member_of" class="tsd-kind-icon">Member of</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#Name" class="tsd-kind-icon">Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#On_a_Match" class="tsd-kind-icon">On a <wbr/>Match</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Oracles" class="tsd-kind-icon">Oracles</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleBase.html#Source" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Table" class="tsd-kind-icon">Table</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleBase.html#Usage" class="tsd-kind-icon">Usage</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>