profectus-docs/assets/api_features_conversion_functions_createCumulativeConversion.md.mqxRjS9F.lean.js

1 line
4.1 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as o,c as t,a0 as a,o as r}from"./chunks/framework.P9qPzDnn.js";const h=JSON.parse('{"title":"Function: createCumulativeConversion()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/conversion/functions/createCumulativeConversion.md","filePath":"api/features/conversion/functions/createCumulativeConversion.md","lastUpdated":null}'),n={name:"api/features/conversion/functions/createCumulativeConversion.md"};function c(i,e,s,u,d,l){return r(),t("div",null,e[0]||(e[0]=[a('<p><a href="./../../../">Profectus</a> / <a href="./../">features/conversion</a> / createCumulativeConversion</p><h1 id="function-createcumulativeconversion" tabindex="-1">Function: createCumulativeConversion() <a class="header-anchor" href="#function-createcumulativeconversion" aria-label="Permalink to &quot;Function: createCumulativeConversion()&quot;"></a></h1><blockquote><p><strong>createCumulativeConversion</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <code>object</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code>, <code>&quot;baseResource&quot;</code> | <code>&quot;gainResource&quot;</code> | <code>&quot;formula&quot;</code> | <code>&quot;currentGain&quot;</code> | <code>&quot;actualGain&quot;</code> | <code>&quot;currentAt&quot;</code> | <code>&quot;nextAt&quot;</code> | <code>&quot;convert&quot;</code> | <code>&quot;spend&quot;</code> | <code>&quot;buyMax&quot;</code> | <code>&quot;onConvert&quot;</code>&gt;, keyof <a href="./../interfaces/ConversionOptions"><code>ConversionOptions</code></a>&gt; &amp; <code>object</code></p></blockquote><p>Creates a conversion that simply adds to the gainResource amount upon converting. This is similar to the behavior of &quot;normal&quot; layers in The Modding Tree. This is equivalent to just calling createConversion directly.</p><h2 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type Parameters&quot;"></a></h2><p>• <strong>T</strong> <em>extends</em> <a href="./../interfaces/ConversionOptions"><code>ConversionOptions</code></a></p><h2 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h2><h3 id="optionsfunc" tabindex="-1">optionsFunc <a class="header-anchor" href="#optionsfunc" aria-label="Permalink to &quot;optionsFunc&quot;"></a></h3><p>() =&gt; <code>T</code></p><p>Conversion options.</p><h2 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h2><p><code>object</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys" target="_blank" rel="noreferrer"><code>Omit</code></a>&lt;<code>T</code>, <code>&quot;baseResource&quot;</code> | <code>&quot;gainResource&quot;</code> | <code>&quot;formula&quot;</code> | <code>&quot;currentGain&quot;</code> | <code>&quot;actualGain&quot;</code> | <code>&quot;currentAt&quot;</code> | <code>&quot;nextAt&quot;</code> | <code>&quot;convert&quot;</code> | <code>&quot;spend&quot;</code> | <code>&quot;buyMax&quot;</code> | <code>&quot;onConvert&quot;</code>&gt;, keyof <a href="./../interfaces/ConversionOptions"><code>ConversionOptions</code></a>&gt; &amp; <code>object</code></p><h2 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h2><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/conversion.ts#L224" target="_blank" rel="noreferrer">profectus/src/features/conversion.ts:224</a></p>',14)]))}const q=o(n,[["render",c]]);export{h as __pageData,q as default};