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.
21 lines • 21.2 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IOracleUsage | 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.IOracleUsage.html">IOracleUsage</a></li></ul><h1>Interface IOracleUsage </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>Describes the recommended usage of this item.</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.IHasRequirements.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasRequirements</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.IHasRollTemplate.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasRollTemplate</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IOracleUsage</span></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.IOracleUsage.html#Allow_duplicates" class="tsd-kind-icon">Allow duplicates</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Initial" class="tsd-kind-icon">Initial</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Max_rolls" class="tsd-kind-icon">Max rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Min_rolls" class="tsd-kind-icon">Min rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Repeatable" class="tsd-kind-icon">Repeatable</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IOracleUsage.html#Requires" class="tsd-kind-icon">Requires</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleUsage.html#Roll_template" class="tsd-kind-icon">Roll template</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Sets" class="tsd-kind-icon">Sets</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IOracleUsage.html#Suggestions" class="tsd-kind-icon">Suggestions</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="Allow_duplicates" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Allow duplicates<a href="#Allow_duplicates" 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">Allow duplicates<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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/IOracleUsage.ts#L36">json_out/oracles/IOracleUsage.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether multiple rolls (as in object generation, or with <a href="Json_Oracles.IMultipleRolls.html">IMultipleRolls</a>) .</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Initial" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Initial<a href="#Initial" 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">Initial<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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/IOracleUsage.ts#L15">json_out/oracles/IOracleUsage.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>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 <em>most</em> cases.</p>
</div><div><p>That said, the game itself recommends <strong>against</strong> rolling all possible results at once (see "Peeling the Onion", p. 293, <em>Starforged</em>). If your goal is to implement the game 'as-written', consider how you might include some means of "progressive disclosure" of oracle results.</p>
<p>May be deprecated in the future in favour of dedicated object template information.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Max_rolls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Max rolls<a href="#Max_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">Max rolls<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/IOracleUsage.ts#L26">json_out/oracles/IOracleUsage.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The maximum number of rolls when using this oracle to create a game object. Assume it's 1 if not specified.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Min_rolls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Min rolls<a href="#Min_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">Min rolls<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/IOracleUsage.ts#L22">json_out/oracles/IOracleUsage.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The minimum number of rolls when using this oracle to create a game object, <em>if</em> this oracle is rolled. Assume it's 1 if not specified.</p>
</div><dl class="tsd-comment-tags"><dt>deprecated</dt><dd><p>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.</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Repeatable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Repeatable<a href="#Repeatable" 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">Repeatable<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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/IOracleUsage.ts#L32">json_out/oracles/IOracleUsage.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>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.</p>
</div><div><p>Mutually exclusive with <code>Max rolls</code>. If undefined, assume <code>false</code>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="Requires" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Requires<a href="#Requires" 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">Requires<span class="tsd-signature-symbol">?:</span> <a href="Json_Meta.IRequirements.html" class="tsd-signature-type" data-tsd-kind="Interface">IRequirements</a></div><aside class="tsd-sources"><p>Overrides Partial.Requires</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/oracles/IOracleUsage.ts#L17">json_out/oracles/IOracleUsage.ts:17</a></li></ul></aside></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="Sets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Sets<a href="#Sets" 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">Sets<span class="tsd-signature-symbol">?:</span> <a href="Json_GameObjects.IAttributeChoices.html" class="tsd-signature-type" data-tsd-kind="Interface">IAttributeChoices</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/IOracleUsage.ts#L40">json_out/oracles/IOracleUsage.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Hints which attributes are set by this table.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><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>Overrides Partial.Suggestions</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/oracles/IOracleUsage.ts#L16">json_out/oracles/IOracleUsage.ts:16</a></li></ul></aside></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.IOracleUsage.html" class="tsd-kind-icon">IOracle<wbr/>Usage</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Allow_duplicates" class="tsd-kind-icon">Allow duplicates</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Initial" class="tsd-kind-icon">Initial</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Max_rolls" class="tsd-kind-icon">Max rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Min_rolls" class="tsd-kind-icon">Min rolls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Repeatable" class="tsd-kind-icon">Repeatable</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IOracleUsage.html#Requires" class="tsd-kind-icon">Requires</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Oracles.IOracleUsage.html#Roll_template" class="tsd-kind-icon">Roll template</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Oracles.IOracleUsage.html#Sets" class="tsd-kind-icon">Sets</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Oracles.IOracleUsage.html#Suggestions" class="tsd-kind-icon">Suggestions</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>