profectus-docs/assets/api_modules_features_common.md.9e7d2a43.js

5 lines
12 KiB
JavaScript
Raw Normal View History

import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Module: features/decorators/common","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/common.md","lastUpdated":null}'),r={name:"api/modules/features/common.md"},c=o(`<h1 id="module-features-decorators-common" tabindex="-1">Module: features/decorators/common <a class="header-anchor" href="#module-features-decorators-common" aria-label="Permalink to &quot;Module: features/decorators/common&quot;"></a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;"></a></h2><h3 id="effectfeatureoptions" tabindex="-1">EffectFeatureOptions <a class="header-anchor" href="#effectfeatureoptions" aria-label="Permalink to &quot;EffectFeatureOptions&quot;"></a></h3><p>• <strong>EffectFeatureOptions</strong>: <code>Object</code></p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>effect</code></td><td style="text-align:left;"><code>any</code></td></tr></tbody></table><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/c9ca859/src/features/decorators/common.ts#L14" target="_blank" rel="noreferrer">profectus/src/features/decorators/common.ts:14</a></p><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;"></a></h2><h3 id="decorator" tabindex="-1">Decorator <a class="header-anchor" href="#decorator" aria-label="Permalink to &quot;Decorator&quot;"></a></h3><p>Ƭ <strong>Decorator</strong>&lt;<code>FeatureOptions</code>, <code>BaseFeature</code>, <code>GenericFeature</code>, <code>S</code>&gt;: <code>Object</code></p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type parameters&quot;"></a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>FeatureOptions</code></td><td style="text-align:left;"><code>FeatureOptions</code></td></tr><tr><td style="text-align:left;"><code>BaseFeature</code></td><td style="text-align:left;"><code>object</code></td></tr><tr><td style="text-align:left;"><code>GenericFeature</code></td><td style="text-align:left;"><code>BaseFeature</code></td></tr><tr><td style="text-align:left;"><code>S</code></td><td style="text-align:left;">extends <a href="./../game/persistence#state"><code>State</code></a> = <a href="./../game/persistence#state"><code>State</code></a></td></tr></tbody></table><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;"></a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>getGatheredProps?</code></td><td style="text-align:left;">(<code>feature</code>: <a href="./feature#optionsobject"><code>OptionsObject</code></a>&lt;<code>FeatureOptions</code>, <code>BaseFeature</code> &amp; { <code>id</code>: <code>string</code> }, <code>GenericFeature</code>&gt;) =&gt; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" target="_blank" rel="noreferrer"><code>Partial</code></a>&lt;<a href="./feature#optionsobject"><code>OptionsObject</code></a>&lt;<code>FeatureOptions</code>, <code>BaseFeature</code> &amp; { <code>id</code>: <code>string</code> }, <code>GenericFeature</code>&gt;&gt;</td></tr><tr><td style="text-align:left;"><code>getPersistentData?</code></td><td style="text-align:left;">() =&gt; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordke
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#F07178;">effect</span><span style="color:#89DDFF;">()</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">{</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;font-style:italic;">return</span><span style="color:#F07178;"> </span><span style="color:#A6ACCD;">Decimal</span><span style="color:#89DDFF;">.</span><span style="color:#82AAFF;">pow</span><span style="color:#F07178;">(</span><span style="color:#F78C6C;">2</span><span style="color:#89DDFF;">,</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">this.</span><span style="color:#A6ACCD;">amount</span><span style="color:#F07178;">)</span><span style="color:#89DDFF;">;</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">},</span></span>
<span class="line"><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">...</span></span>
<span class="line"><span style="color:#89DDFF;">}</span><span style="color:#A6ACCD;">)</span><span style="color:#89DDFF;">,</span><span style="color:#A6ACCD;"> effectDecorator) </span><span style="color:#89DDFF;font-style:italic;">as</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">GenericUpgrade</span><span style="color:#A6ACCD;"> </span><span style="color:#89DDFF;">&amp;</span><span style="color:#A6ACCD;"> </span><span style="color:#FFCB6B;">GenericEffectFeature</span><span style="color:#89DDFF;">;</span></span></code></pre></div><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/c9ca859/src/features/decorators/common.ts#L38" target="_blank" rel="noreferrer">profectus/src/features/decorators/common.ts:38</a></p>`,41),s=[c];function n(d,l,i,p,f,u){return a(),t("div",null,s)}const y=e(r,[["render",n]]);export{m as __pageData,y as default};