2 lines
13 KiB
JavaScript
2 lines
13 KiB
JavaScript
|
import{_ as r,c as a,a0 as o,o as t}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: ConversionOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/conversion/interfaces/ConversionOptions.md","filePath":"api/features/conversion/interfaces/ConversionOptions.md","lastUpdated":null}'),n={name:"api/features/conversion/interfaces/ConversionOptions.md"};function i(s,e,c,l,u,h){return t(),a("div",null,e[0]||(e[0]=[o('<p><a href="./../../../">Profectus</a> / <a href="./../">features/conversion</a> / ConversionOptions</p><h1 id="interface-conversionoptions" tabindex="-1">Interface: ConversionOptions <a class="header-anchor" href="#interface-conversionoptions" aria-label="Permalink to "Interface: ConversionOptions""></a></h1><p>An object that configures a <a href="./Conversion">Conversion</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="actualgain" tabindex="-1">actualGain? <a class="header-anchor" href="#actualgain" aria-label="Permalink to "actualGain?""></a></h3><blockquote><p><code>optional</code> <strong>actualGain</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><p>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="./ConversionOptions#currentgain">currentGain</a> in the cases where the conversion isn't just adding the converted amount to the output resource.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/conversion.ts#L33" target="_blank" rel="noreferrer">profectus/src/features/conversion.ts:33</a></p><hr><h3 id="baseresource" tabindex="-1">baseResource <a class="header-anchor" href="#baseresource" aria-label="Permalink to "baseResource""></a></h3><blockquote><p><strong>baseResource</strong>: <a href="./../../resources/resource/interfaces/Resource"><code>Resource</code></a></p></blockquote><p>The input <a href="./../../resources/resource/interfaces/Resource">features/resources/resource.Resource</a> for this conversion.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/conversion.ts#L48" target="_blank" rel="noreferrer">profectus/src/features/conversion.ts:48</a></p><hr><h3 id="buymax" tabindex="-1">buyMax? <a class="header-anchor" href="#buymax" aria-label="Permalink to "buyMax?""></a></h3><blockquote><p><code>optional</code> <strong>buyMax</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a><<code>boolean</code>></p></blockquote><p>Whether or not to cap the amount of the output resource gained by converting at 1. Defaults to true.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/conversion.ts#L57" target="_blank" rel="noreferrer">profectus/src/features/conversion.ts:57</a></p><hr><h3 id="convert" tabindex="-1">convert? <a class="header-anchor" href="#convert" aria-label="Permalink to "convert?""></a></h3><blockquote><p><code>optional</code> <strong>convert</strong>: <code>VoidFunction</code></p></blockquote><p>The function that performs the actual conversion from <a
|