profectus-docs/assets/api_modules_features_conversion.md.61b07407.js

import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Module: features/conversion","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/conversion.md","lastUpdated":null}'),r={name:"api/modules/features/conversion.md"},n=a('<h1 id="module-features-conversion" tabindex="-1">Module: features/conversion <a class="header-anchor" href="#module-features-conversion" aria-label="Permalink to &quot;Module: features/conversion&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="baseconversion" tabindex="-1">BaseConversion <a class="header-anchor" href="#baseconversion" aria-label="Permalink to &quot;BaseConversion&quot;">​</a></h3><p>• <strong>BaseConversion</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./conversion#conversionoptions">ConversionOptions</a> to create a <a href="./conversion#conversion">Conversion</a>.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>convert</code></td><td style="text-align:left;"><code>VoidFunction</code></td><td style="text-align:left;">The function that performs the actual conversion.</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/c386ace/src/features/conversion.ts#L84" target="_blank" rel="noreferrer">profectus/src/features/conversion.ts:84</a></p><hr><h3 id="conversionoptions" tabindex="-1">ConversionOptions <a class="header-anchor" href="#conversionoptions" aria-label="Permalink to &quot;ConversionOptions&quot;">​</a></h3><p>• <strong>ConversionOptions</strong>: <code>Object</code></p><p>An object that configures a <a href="./conversion#conversion">Conversion</a>.</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>actualGain?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a>&lt;<a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>&gt;</td><td style="text-align:left;">The absolute amount the output resource will be changed by. Typically this will be set for you in a conversion constructor. This will differ from <a href="./conversion#currentgain">currentGain</a> in the cases where the conversion isn&#39;t just adding the converted amount to the output resource.</td></tr><tr><td style="text-align:left;"><code>baseResource</code></td><td style="text-align:left;"><a href="./resource#resource"><code>Resource</code></a>&lt;<a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>&gt;</td><td style="text-align:left;">The input <a href="./resource#resource">Resource</a> for this conversion.</td></tr><tr><td style="text-align:left;"><code>buyMax?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</td><td style="text-align:left;">Whether or not to cap the amount of the output resource gained by converting at 1. Defaults to true.</td></tr><tr><td style="text-align:left;"><code>convert?</code></td><td style="text-align:left;"><code>VoidFunction</code></td><td style="text-align:left;">The function that performs the actual conversion from <a href="./conversion#baseresource">baseResource</a> to <a href="./conversion#gainresource">gainResource</a>. Typically this will be set for you in a conversion constructor.</td></tr><tr><td style="text-align:left;"><code>currentAt?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a>&l