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.
20 lines • 20.3 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAssetAbility | 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_Assets.html">Json.Assets</a></li><li><a href="Json_Assets.IAssetAbility.html">IAssetAbility</a></li></ul><h1>Interface IAssetAbility </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 one of an asset's three abilities.</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><a href="Json_Meta.IHasText.html" class="tsd-signature-type" data-tsd-kind="Interface">IHasText</a><ul class="tsd-hierarchy"><li><span class="target">IAssetAbility</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_Assets.IAssetAbility.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Alter_Momentum" class="tsd-kind-icon">Alter <wbr/>Momentum</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Alter_Moves" class="tsd-kind-icon">Alter <wbr/>Moves</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Alter_Properties" class="tsd-kind-icon">Alter <wbr/>Properties</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Enabled" class="tsd-kind-icon">Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Inputs" class="tsd-kind-icon">Inputs</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Moves" class="tsd-kind-icon">Moves</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Name" class="tsd-kind-icon">Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAbility.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/assets/IAssetAbility.ts#L11">json_out/assets/IAssetAbility.ts:11</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>pattern</dt><dd><p>^(Starforged|Ironsworn)/Assets/[A-z_-]+/[A-z_-]+/Abilities/[1-3]$</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Alter_Momentum" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Alter <wbr/>Momentum<a href="#Alter_Momentum" 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">Alter <wbr/>Momentum<span class="tsd-signature-symbol">?:</span> <a href="Json_Assets.IAlterMomentum.html" class="tsd-signature-type" data-tsd-kind="Interface">IAlterMomentum</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAssetAbility.ts#L35">json_out/assets/IAssetAbility.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on how this ability alters its owner's momentum (triggers an effect on burn, on reset, etc)</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Alter_Moves" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Alter <wbr/>Moves<a href="#Alter_Moves" 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">Alter <wbr/>Moves<span class="tsd-signature-symbol">?:</span> <a href="Json_Assets.IAlterMove.html" class="tsd-signature-type" data-tsd-kind="Interface">IAlterMove</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/assets/IAssetAbility.ts#L27">json_out/assets/IAssetAbility.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on how this ability alters moves when enabled.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Alter_Properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Alter <wbr/>Properties<a href="#Alter_Properties" 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">Alter <wbr/>Properties<span class="tsd-signature-symbol">?:</span> <a href="Json_Assets.IAssetAlterProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">IAssetAlterProperties</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAssetAbility.ts#L31">json_out/assets/IAssetAbility.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on how this ability alters its parent asset when enabled.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Enabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Enabled<a href="#Enabled" 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">Enabled<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/assets/IAssetAbility.ts#L39">json_out/assets/IAssetAbility.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Whether the asset ability is enabled or not. In most cases, the first asset ability defaults to 'true' and the others to 'false'. If none of an asset's abilities are set to 'true', the player can pick which the ability they start with when purchasing the asset.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Inputs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Inputs<a href="#Inputs" 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">Inputs<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><a href="Json_Assets.IInputText.html" class="tsd-signature-type" data-tsd-kind="Interface">IInputText</a><span class="tsd-signature-symbol"> | </span><a href="Json_Assets.IInputNumber.html" class="tsd-signature-type" data-tsd-kind="Interface">IInputNumber</a><span class="tsd-signature-symbol"> | </span><a href="Json_Assets.IInputClock.html" class="tsd-signature-type" data-tsd-kind="Interface">IInputClock</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/assets/IAssetAbility.ts#L23">json_out/assets/IAssetAbility.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>User inputs (text, clocks, etc) associated with this asset ability.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Moves" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Moves<a href="#Moves" 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">Moves<span class="tsd-signature-symbol">?:</span> <a href="Json_Moves.IMove.html" class="tsd-signature-type" data-tsd-kind="Interface">IMove</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/assets/IAssetAbility.ts#L19">json_out/assets/IAssetAbility.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>New moves added by this asset ability.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="Name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> 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"><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAssetAbility.ts#L15">json_out/assets/IAssetAbility.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Ironsworn companion assets provide names for their abilities. Starforged asset abilities do not have names.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Text" class="tsd-anchor"></a><h3 class="tsd-anchor-link">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>Inherited from <a href="Json_Meta.IHasText.html">IHasText</a>.<a href="Json_Meta.IHasText.html#Text">Text</a></p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/meta/IHas.ts#L95">json_out/meta/IHas.ts:95</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The item's rules text as a markdown string.</p>
</div><dl class="tsd-comment-tags"><dt>markdown</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="current 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=" 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_Assets.IAssetAbility.html" class="tsd-kind-icon">IAsset<wbr/>Ability</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="Json_Assets.IAssetAbility.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Alter_Momentum" class="tsd-kind-icon">Alter <wbr/>Momentum</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Alter_Moves" class="tsd-kind-icon">Alter <wbr/>Moves</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Alter_Properties" class="tsd-kind-icon">Alter <wbr/>Properties</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Enabled" class="tsd-kind-icon">Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Inputs" class="tsd-kind-icon">Inputs</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Moves" class="tsd-kind-icon">Moves</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="Json_Assets.IAssetAbility.html#Name" class="tsd-kind-icon">Name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAbility.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>