profectus-docs/assets/api_interfaces_features_conversion.ConversionOptions.md.4a125d3b.js

2 lines
15 KiB
JavaScript
Raw Normal View History

import{_ as e,c as r,o as t,a as o}from"./app.ab34650d.js";const m=JSON.parse('{"title":"Interface: ConversionOptions","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"actualGain","slug":"actualgain"},{"level":3,"title":"baseResource","slug":"baseresource"},{"level":3,"title":"buyMax","slug":"buymax"},{"level":3,"title":"convert","slug":"convert"},{"level":3,"title":"costModifier","slug":"costmodifier"},{"level":3,"title":"currentAt","slug":"currentat"},{"level":3,"title":"currentGain","slug":"currentgain"},{"level":3,"title":"gainModifier","slug":"gainmodifier"},{"level":3,"title":"gainResource","slug":"gainresource"},{"level":3,"title":"nextAt","slug":"nextat"},{"level":3,"title":"onConvert","slug":"onconvert"},{"level":3,"title":"roundUpCost","slug":"roundupcost"},{"level":3,"title":"scaling","slug":"scaling"},{"level":3,"title":"spend","slug":"spend"}],"relativePath":"api/interfaces/features/conversion.ConversionOptions.md","lastUpdated":null}'),a={name:"api/interfaces/features/conversion.ConversionOptions.md"},n=o('<h1 id="interface-conversionoptions" tabindex="-1">Interface: ConversionOptions <a class="header-anchor" href="#interface-conversionoptions" aria-hidden="true">#</a></h1><p><a href="./../../modules/features/conversion.html">features/conversion</a>.ConversionOptions</p><p>An object that configures a <a href="./../../modules/features/conversion.html#conversion">Conversion</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="actualgain" tabindex="-1">actualGain <a class="header-anchor" href="#actualgain" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>actualGain</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<a href="./../../modules/lib/break_eternity.html#decimalsource"><code>DecimalSource</code></a>&gt;</p><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="./conversion.ConversionOptions.html#currentgain">currentGain</a> in the cases where the conversion isn&#39;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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/conversion.ts#L31" target="_blank" rel="noopener noreferrer">profectus/src/features/conversion.ts:31</a></p><hr><h3 id="baseresource" tabindex="-1">baseResource <a class="header-anchor" href="#baseresource" aria-hidden="true">#</a></h3><p>\u2022 <strong>baseResource</strong>: <a href="./resources/resource.Resource"><code>Resource</code></a>&lt;<a href="./../../modules/lib/break_eternity.html#decimalsource"><code>DecimalSource</code></a>&gt;</p><p>The input <a href="./resources/resource.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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/conversion.ts#L46" target="_blank" rel="noopener noreferrer">profectus/src/features/conversion.ts:46</a></p><hr><h3 id="buymax" tabindex="-1">buyMax <a class="header-anchor" href="#buymax" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>buyMax</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/conversion.ts#L55" target="_blank" rel="noopener noreferrer">profectus/src/features/conversion.ts:55</a></p><hr><h3 id="convert" ta