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.
14 lines • 12.9 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IMoveTrigger | 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_Moves.html">Json.Moves</a></li><li><a href="Json_Moves.IMoveTrigger.html">IMoveTrigger</a></li></ul><h1>Interface IMoveTrigger </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 trigger conditions of the move.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="Json_Meta.IHasId.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasId</a></li><li><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="Json_Meta.IHasText.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasText</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IMoveTrigger</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_Moves.IMoveTrigger.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Moves.IMoveTrigger.html#By" class="tsd-kind-icon">By</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Moves.IMoveTrigger.html#Options" class="tsd-kind-icon">Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Moves.IMoveTrigger.html#Text" class="tsd-kind-icon">Text</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 <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/moves/IMoveTrigger.ts#L11">json_out/moves/IMoveTrigger.ts:11</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^(Starforged|Ironsworn)/(Moves/[A-z_-]+/[A-z_-]+|Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/Alter_Moves/[0-9]+|Moves/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]/[A-z_-]+)/Trigger$</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="By" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> By<a href="#By" 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">By<span class="tsd-signature-symbol">?:</span> <a href="Json_Moves.IMoveTriggerBy.html" class="tsd-signature-type" data-tsd-kind="Interface">IMoveTriggerBy</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/moves/IMoveTrigger.ts#L26">json_out/moves/IMoveTrigger.ts:26</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on who can trigger this item. Used mainly by asset abilities, some of which can trigger from an Ally's move.</p>
</div><div><p>If unspecified, assume <code>Ally</code> is <code>false</code> and <code>Player</code> is <code>true</code>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Options<a href="#Options" 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">Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><a href="Json_Moves.IMoveTriggerOptionAction.html" class="tsd-signature-type" data-tsd-kind="Interface">IMoveTriggerOptionAction</a><span class="tsd-signature-symbol"> | </span><a href="Json_Moves.IMoveTriggerOptionProgress.html" class="tsd-signature-type" data-tsd-kind="Interface">IMoveTriggerOptionProgress</a><span class="tsd-signature-symbol">)</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/moves/IMoveTrigger.ts#L32">json_out/moves/IMoveTrigger.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on any action rolls or progress rolls that are made when this move is triggered (which may describe a specific subset of the primary trigger in their own <code>Text</code> property).</p>
</div><div><p>If there's no action rolls or progress rolls attached to this move, this is <code>undefined</code>.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="Text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Text<a href="#Text" 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">Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Overrides Partial.Text</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/moves/IMoveTrigger.ts#L20">json_out/moves/IMoveTrigger.ts:20</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A markdown string containing the primary trigger text for this move.</p>
</div><div><p>Secondary triggers (for specific stats or uses of an asset ability) are described in <code>Options</code>.</p>
</div><dl class="tsd-comment-tags"><dt>markdown</dt><dd></dd><dt>example</dt><dd><p>"When you attempt something risky or react to an imminent threat..."</p>
</dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Assets.html">Json.<wbr/>Assets</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Common.html">Json.<wbr/>Common</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Cyclopedia.html">Json.<wbr/>Cyclopedia</a></li><li class=" tsd-kind-module"><a href="../modules/Json_GameObjects.html">Json.<wbr/>Game<wbr/>Objects</a></li><li class=" tsd-kind-module"><a href="../modules/Json_Meta.html">Json.<wbr/>Meta</a></li><li class="current 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_Moves.IMoveTrigger.html" class="tsd-kind-icon">IMove<wbr/>Trigger</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Moves.IMoveTrigger.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Moves.IMoveTrigger.html#By" class="tsd-kind-icon">By</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Moves.IMoveTrigger.html#Options" class="tsd-kind-icon">Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Moves.IMoveTrigger.html#Text" class="tsd-kind-icon">Text</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>