@danielhlockard/dataforged
Version:
Official content and rules data for the Ironsworn: Starforged tabletop role-playing game, formatted as JSON for use in community tools. 🚀 Pure ESM module optimized for AI Studio and modern JavaScript environments.
9 lines • 20 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IEncounterVariant | 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_Cyclopedia.html">Json.Cyclopedia</a></li><li><a href="Json_Cyclopedia.IEncounterVariant.html">IEncounterVariant</a></li></ul><h1>Interface IEncounterVariant </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>Represents a variant encounter 'stubs' included with a parent encounter in <em>Ironsworn: Starforged</em>.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">StubBy</span><span class="tsd-signature-symbol"><</span><a href="Json_Cyclopedia.IEncounterStarforged.html" class="tsd-signature-type" data-tsd-kind="Interface">IEncounterStarforged</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"Features"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Drives"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Tactics"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Variants"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Summary"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Your Truth"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"Quest Starter"</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IEncounterVariant</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 tsd-is-overwrite"><a href="Json_Cyclopedia.IEncounterVariant.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Description" class="tsd-kind-icon">Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Name" class="tsd-kind-icon">Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Nature" class="tsd-kind-icon">Nature</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Rank" class="tsd-kind-icon">Rank</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Source" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Tags" class="tsd-kind-icon">Tags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Cyclopedia.IEncounterVariant.html#Variant_of" class="tsd-kind-icon">Variant of</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-overwrite"><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>Overrides StubBy.$id</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/cyclopedia/IEncounterVariant.ts#L12">json_out/cyclopedia/IEncounterVariant.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^Starforged/Encounters/[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="Description" class="tsd-anchor"></a><h3 class="tsd-anchor-link">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 StubBy.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-inherited"><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>Inherited from StubBy.Display</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/cyclopedia/IEncounterBase.ts#L22">json_out/cyclopedia/IEncounterBase.ts:22</a></li></ul></aside></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 StubBy.Name</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/cyclopedia/IEncounterBase.ts#L17">json_out/cyclopedia/IEncounterBase.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>example</dt><dd><p>"Chiton"</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Nature" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Nature<a href="#Nature" 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">Nature<span class="tsd-signature-symbol">:</span> <a href="../enums/Json_Cyclopedia.EncounterNatureStarforged.html" class="tsd-signature-type" data-tsd-kind="Enumeration">EncounterNatureStarforged</a></div><aside class="tsd-sources"><p>Inherited from StubBy.Nature</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/cyclopedia/IEncounterStarforged.ts#L12">json_out/cyclopedia/IEncounterStarforged.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Rank" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Rank<a href="#Rank" 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">Rank<span class="tsd-signature-symbol">:</span> <a href="../enums/Json_Common.ChallengeRank.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ChallengeRank</a></div><aside class="tsd-sources"><p>Inherited from StubBy.Rank</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/cyclopedia/IEncounterBase.ts#L29">json_out/cyclopedia/IEncounterBase.ts:29</a></li></ul></aside></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 StubBy.Source</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 tsd-is-inherited"><a id="Tags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Tags<a href="#Tags" 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">Tags<span class="tsd-signature-symbol">?:</span> <a href="../enums/Json_Cyclopedia.EncounterTags.html#Vehicle" class="tsd-signature-type" data-tsd-kind="Enumeration Member">Vehicle</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from StubBy.Tags</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/cyclopedia/IEncounterBase.ts#L28">json_out/cyclopedia/IEncounterBase.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Variant_of" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Variant of<a href="#Variant_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">Variant 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/cyclopedia/IEncounterVariant.ts#L13">json_out/cyclopedia/IEncounterVariant.ts:13</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="current 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=" 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_Cyclopedia.IEncounterVariant.html" class="tsd-kind-icon">IEncounter<wbr/>Variant</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Cyclopedia.IEncounterVariant.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Description" class="tsd-kind-icon">Description</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Name" class="tsd-kind-icon">Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Nature" class="tsd-kind-icon">Nature</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Rank" class="tsd-kind-icon">Rank</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Source" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Cyclopedia.IEncounterVariant.html#Tags" class="tsd-kind-icon">Tags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Cyclopedia.IEncounterVariant.html#Variant_of" class="tsd-kind-icon">Variant of</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>