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.
33 lines • 32.2 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAssetAlterProperties | 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.IAssetAlterProperties.html">IAssetAlterProperties</a></li></ul><h1>Interface IAssetAlterProperties </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 changes that an asset ability makes to its parent asset when active. Any properties with object values should be merged recursively.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><p>An <code>IAssetAlterProperties</code> that would set <code>IAsset["Condition Meter"].Max</code> to 3, and leave its other properties unchanged:</p>
<pre><code class="language-javascript"><span class="hl-0">{ </span><span class="hl-3">"Condition Meter"</span><span class="hl-0">: { </span><span class="hl-2">Max:</span><span class="hl-0"> </span><span class="hl-7">3</span><span class="hl-0"> } }</span>
</code></pre>
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">PartialDeep</span><span class="tsd-signature-symbol"><</span><a href="Json_Assets.IAsset.html" class="tsd-signature-type" data-tsd-kind="Interface">IAsset</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">IAssetAlterProperties</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 tsd-is-inherited"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Abilities" class="tsd-kind-icon">Abilities</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Aliases" class="tsd-kind-icon">Aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Asset_Type" class="tsd-kind-icon">Asset <wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Attachments" class="tsd-kind-icon">Attachments</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Condition_Meter" class="tsd-kind-icon">Condition <wbr/>Meter</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Inputs" class="tsd-kind-icon">Inputs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.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.IAssetAlterProperties.html#Requirement" class="tsd-kind-icon">Requirement</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Source" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#States" class="tsd-kind-icon">States</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Tags" class="tsd-kind-icon">Tags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Usage" class="tsd-kind-icon">Usage</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited"><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"><span class="tsd-flag ts-flagOptional">Optional</span> $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 PartialDeep.$id</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L12">json_out/assets/IAsset.ts:12</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>example</dt><dd><p>"Starforged/Assets/Path/Bounty_Hunter"</p>
</dd><dt>pattern</dt><dd><p>^(Starforged|Ironsworn)/Assets/[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="Abilities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Abilities<a href="#Abilities" 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">Abilities<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">[</span><a href="Json_Assets.IAssetAbility.html" class="tsd-signature-type" data-tsd-kind="Interface">IAssetAbility</a><span class="tsd-signature-symbol">, </span><a href="Json_Assets.IAssetAbility.html" class="tsd-signature-type" data-tsd-kind="Interface">IAssetAbility</a><span class="tsd-signature-symbol">, </span><a href="Json_Assets.IAssetAbility.html" class="tsd-signature-type" data-tsd-kind="Interface">IAssetAbility</a><span class="tsd-signature-symbol">]</span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Abilities</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L49">json_out/assets/IAsset.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The asset's abilities.</p>
</div></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">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.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 tsd-is-inherited"><a id="Asset_Type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Asset <wbr/>Type<a href="#Asset_Type" 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">Asset <wbr/>Type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Asset Type</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L27">json_out/assets/IAsset.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ID of the asset's parent AssetType</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><p>"Starforged/Assets/Path"</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Attachments" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Attachments<a href="#Attachments" 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">Attachments<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="Json_Assets.IAssetAttachment.html" class="tsd-signature-type" data-tsd-kind="Interface">IAssetAttachment</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Attachments</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L35">json_out/assets/IAsset.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Details on what attachments (other assets) are accepted by this asset.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Condition_Meter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Condition <wbr/>Meter<a href="#Condition_Meter" 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">Condition <wbr/>Meter<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="Json_Common.IConditionMeter.html" class="tsd-signature-type" data-tsd-kind="Interface">IConditionMeter</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Condition Meter</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L53">json_out/assets/IAsset.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on this asset's condition meter, if any.</p>
</div></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"><span class="tsd-flag ts-flagOptional">Optional</span> 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> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="Json_Meta.IDisplayWithTitle.html" class="tsd-signature-type" data-tsd-kind="Interface">IDisplayWithTitle</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Display</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L18">json_out/assets/IAsset.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><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-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><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.IInputSelect.html" class="tsd-signature-type" data-tsd-kind="Interface">IInputSelect</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Inputs</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L39">json_out/assets/IAsset.ts:39</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Data describing the Input controls that should be embedded in the card. Inputs embedded in specific asset abilities appear as keys of the corresponding ability object, instead.</p>
</div></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"><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"><p>Inherited from PartialDeep.Name</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L17">json_out/assets/IAsset.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The asset's name - the title printed on the card.</p>
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><p>"Bounty Hunter"</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="Requirement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> Requirement<a href="#Requirement" 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">Requirement<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><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 PartialDeep.Requirement</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L45">json_out/assets/IAsset.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>An optional markdown string representing the requirement text that appears at the top of some asset cards.</p>
</div><dl class="tsd-comment-tags"><dt>markdown</dt><dd></dd><dt>example</dt><dd><p>"If you wear your finely crafted set of personal armor..."</p>
</dd></dl></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"><span class="tsd-flag ts-flagOptional">Optional</span> 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> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="Json_Meta.ISource.html" class="tsd-signature-type" data-tsd-kind="Interface">ISource</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.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="States" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> States<a href="#States" 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">States<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="Json_Assets.IAssetState.html" class="tsd-signature-type" data-tsd-kind="Interface">IAssetState</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.States</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L22">json_out/assets/IAsset.ts:22</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Describes any states that the asset might have, such as "Broken". Some states may disable the asset entirely.</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> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Tags</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L55">json_out/assets/IAsset.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><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> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="Json_Assets.IAssetUsage.html" class="tsd-signature-type" data-tsd-kind="Interface">IAssetUsage</a><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><p>Inherited from PartialDeep.Usage</p><ul><li>Defined in <a href="https://github.com/rsek/dataforged/blob/33730e7f/dataforged-tools/src/json_out/assets/IAsset.ts#L31">json_out/assets/IAsset.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Information on the asset's usage, such as whether its abilities are shared amongst the player characters.</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="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.IAssetAlterProperties.html" class="tsd-kind-icon">IAsset<wbr/>Alter<wbr/>Properties</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#_id" class="tsd-kind-icon">$id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Abilities" class="tsd-kind-icon">Abilities</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Aliases" class="tsd-kind-icon">Aliases</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Asset_Type" class="tsd-kind-icon">Asset <wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Attachments" class="tsd-kind-icon">Attachments</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Condition_Meter" class="tsd-kind-icon">Condition <wbr/>Meter</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Display" class="tsd-kind-icon">Display</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Inputs" class="tsd-kind-icon">Inputs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.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.IAssetAlterProperties.html#Requirement" class="tsd-kind-icon">Requirement</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Source" class="tsd-kind-icon">Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#States" class="tsd-kind-icon">States</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.html#Tags" class="tsd-kind-icon">Tags</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="Json_Assets.IAssetAlterProperties.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-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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>