1 line
29 KiB
JavaScript
1 line
29 KiB
JavaScript
import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const p=JSON.parse('{"title":"Module: data/common","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/data/common.md","lastUpdated":null}'),r={name:"api/modules/data/common.md"},d=o('<h1 id="module-data-common" tabindex="-1">Module: data/common <a class="header-anchor" href="#module-data-common" aria-label="Permalink to "Module: data/common""></a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to "Interfaces""></a></h2><ul><li><a href="../../interfaces/data/common.LayerTreeNodeOptions">LayerTreeNodeOptions</a></li><li><a href="../../interfaces/data/common.ResetButtonOptions">ResetButtonOptions</a></li><li><a href="../../interfaces/data/common.Section">Section</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to "Type Aliases""></a></h2><h3 id="genericlayertreenode" tabindex="-1">GenericLayerTreeNode <a class="header-anchor" href="#genericlayertreenode" aria-label="Permalink to "GenericLayerTreeNode""></a></h3><p>Ƭ <strong>GenericLayerTreeNode</strong>: <a href="./../features/feature#replace"><code>Replace</code></a><<a href="./common#layertreenode"><code>LayerTreeNode</code></a><<a href="../../interfaces/data/common.LayerTreeNodeOptions"><code>LayerTreeNodeOptions</code></a>>, { <code>append?</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code>> ; <code>display</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a>> }></p><p>A type that matches any valid <a href="./common#layertreenode">LayerTreeNode</a> object.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L201" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:201</a></p><hr><h3 id="genericresetbutton" tabindex="-1">GenericResetButton <a class="header-anchor" href="#genericresetbutton" aria-label="Permalink to "GenericResetButton""></a></h3><p>Ƭ <strong>GenericResetButton</strong>: <a href="./../features/feature#replace"><code>Replace</code></a><<a href="./../features/clickables/clickable#genericclickable"><code>GenericClickable</code></a> & <a href="./common#resetbutton"><code>ResetButton</code></a><<a href="../../interfaces/data/common.ResetButtonOptions"><code>ResetButtonOptions</code></a>>, { <code>canClick</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code>> ; <code>display</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a>> ; <code>minimumGain</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<a href="./../util/bignum#decimalsource"><code>DecimalSource</code></a>> ; <code>resetDescription</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>string</code>> ; <code>showNextAt</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code>> }></p><p>A type that matches any valid <a href="./common#resetbutton">ResetButton</a> object.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L84" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:84</a></p><hr><h3 id="layertreenode" tabindex="-1">LayerTreeNode <a class="header-anchor" href="#layertreenode" aria-label="Permalink to "LayerTreeNode""></a></h3><p>Ƭ <strong>LayerTreeNode</strong><<code>T</code>>: <a href="./../features/feature#replace"><code>Replace</code></a><<a href="./../features/trees/tree#treenode"><code>TreeNode</code></a><<code>T</code>>, { <code>append</code>: <a href="./../util/computed#getcomputabletype"><code>GetComputableType</code></a><<code>T</code>[<code>"append"</code>]> ; <code>display</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a><<code>T</code>[<code>"display"</code>], <code>T</code>[<code>"layerID"</code>]> }></p><p>A tree node that is associated with a given layer, and which opens the layer when clicked.</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to "Type parameters""></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>T</code></td><td style="text-align:left;">extends <a href="../../interfaces/data/common.LayerTreeNodeOptions"><code>LayerTreeNodeOptions</code></a></td></tr></tbody></table><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://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L193" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:193</a></p><hr><h3 id="resetbutton" tabindex="-1">ResetButton <a class="header-anchor" href="#resetbutton" aria-label="Permalink to "ResetButton""></a></h3><p>Ƭ <strong>ResetButton</strong><<code>T</code>>: <a href="./../features/feature#replace"><code>Replace</code></a><<a href="./../features/clickables/clickable#clickable"><code>Clickable</code></a><<code>T</code>>, { <code>canClick</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a><<code>T</code>[<code>"canClick"</code>], <code>Ref</code><<code>boolean</code>>> ; <code>display</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a><<code>T</code>[<code>"display"</code>], <code>Ref</code><<code>JSX.Element</code>>> ; <code>minimumGain</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a><<code>T</code>[<code>"minimumGain"</code>], <code>1</code>> ; <code>onClick</code>: (<code>event?</code>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a>) => <code>void</code> ; <code>resetDescription</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a><<code>T</code>[<code>"resetDescription"</code>], <code>Ref</code><<code>string</code>>> ; <code>showNextAt</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a><<code>T</code>[<code>"showNextAt"</code>], <code>true</code>> }></p><p>A button that is used to control a conversion. It will show how much can be converted currently, and can show when that amount will go up, as well as handle only being clickable when a sufficient amount of currency can be gained. Assumes this button is associated with a specific node on a tree, and triggers that tree's reset propagation.</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-label="Permalink to "Type parameters""></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>T</code></td><td style="text-align:left;">extends <a href="../../interfaces/data/common.ResetButtonOptions"><code>ResetButtonOptions</code></a></td></tr></tbody></table><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L71" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:71</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to "Functions""></a></h2><h3 id="colortext" tabindex="-1">colorText <a class="header-anchor" href="#colortext" aria-label="Permalink to "colorText""></a></h3><p>▸ <strong>colorText</strong>(<code>textToColor</code>, <code>color?</code>): <code>JSX.Element</code></p><p>Creates an HTML string for a span that writes some given text in a given color.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>textToColor</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;"><code>undefined</code></td><td style="text-align:left;">The content to change the color of</td></tr><tr><td style="text-align:left;"><code>color</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;"><code>"var(--accent2)"</code></td><td style="text-align:left;">The color to change the content to look like. Defaults to the current theme's accent 2 variable.</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><code>JSX.Element</code></p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L382" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:382</a></p><hr><h3 id="createcollapsibleachievements" tabindex="-1">createCollapsibleAchievements <a class="header-anchor" href="#createcollapsibleachievements" aria-label="Permalink to "createCollapsibleAchievements""></a></h3><p>▸ <strong>createCollapsibleAchievements</strong>(<code>achievements</code>): <code>Object</code></p><p>Creates a collapsible display of a list of achievements</p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h4><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>achievements</code></td><td style="text-align:left;"><a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <a href="./../features/achievements/achievement#genericachievement"><code>GenericAchievement</code></a>></td><td style="text-align:left;">A dictionary of the achievements to display, inserted in the order from easiest to hardest</td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h4><p><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>collapseAchievements</code></td><td style="text-align:left;"><a href="./../game/persistence#persistent"><code>Persistent</code></a><<code>boolean</code>></td></tr><tr><td style="text-align:left;"><code>display</code></td><td style="text-align:left;"><a href="./../features/feature#jsxfunction"><code>JSXFunction</code></a></td></tr></tbody></table><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L390" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:390</a></p><hr><h3 id="createcollapsiblemodifiersections" tabindex="-1">createCollapsibleModifierSections <a class="header-anchor" href="#createcollapsiblemodifiersections" aria-label="Permalink to "createCollapsibleModifierSections""></a></h3><p>▸ <strong>createCollapsibleModifierSections</strong>(<code>sectionsFunc</code>, <code>smallerIsBetter?</code>): [<a href="./../features/feature#jsxfunction"><code>JSXFunction</code></a>, <a href="./../game/persistence#persistent"><code>Persistent</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>number</code>, <code>boolean</code>>>]</p><p>Takes an array of modifier "sections", and creates a JSXFunction that can render all those sections, and allow each section to be collapsed. Also returns a list of persistent refs that are used to control which sections are currently collapsed.</p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to "Parameters""></a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>sectionsFunc</code></td><td style="text-align:left;">() => <a href="../../interfaces/data/common.Section"><code>Section</code></a>[]</td><td style="text-align:left;"><code>undefined</code></td><td style="text-align:left;">A function that returns the sections to display.</td></tr><tr><td style="text-align:left;"><code>smallerIsBetter</code></td><td style="text-align:left;"><code>boolean</code></td><td style="text-align:left;"><code>false</code></td><td style="text-align:left;">Determines whether numbers larger or smaller than the base should be displayed as red.</td></tr></tbody></table><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to "Returns""></a></h4><p>[<a href="./../features/feature#jsxfunction"><code>JSXFunction</code></a>, <a href="./../game/persistence#persistent"><code>Persistent</code></a><<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>number</code>, <code>boolean</code>>>]</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L264" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:264</a></p><hr><h3 id="createformulapreview" tabindex="-1">createFormulaPreview <a class="header-anchor" href="#createformulapreview" aria-label="Permalink to "createFormulaPreview""></a></h3><p>▸ <strong>createFormulaPreview</strong>(<code>formula</code>, <code>showPreview</code>, <code>previewAmount?</code>): <code>ComputedRef</code><<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a>></p><p>Utility function for displaying the result of a formula such that it will, when told to, preview how the formula's result will change. Requires a formula with a single variable inside.</p><h4 id="parameters-3" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-3" aria-label="Permalink to "Parameters""></a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>formula</code></td><td style="text-align:left;"><a href="./../game/formulas/types#genericformula"><code>GenericFormula</code></a></td><td style="text-align:left;"><code>undefined</code></td><td style="text-align:left;">The formula to display the result of.</td></tr><tr><td style="text-align:left;"><code>showPreview</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a><<code>boolean</code>></td><td style="text-align:left;"><code>undefined</code></td><td style="text-align:left;">Whether or not to preview how the formula's result will change.</td></tr><tr><td style="text-align:left;"><code>previewAmount</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a><<a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></td><td style="text-align:left;"><code>1</code></td><td style="text-align:left;">The amount to <em>add</em> to the current formula's variable amount to preview the change in result.</td></tr></tbody></table><h4 id="returns-3" tabindex="-1">Returns <a class="header-anchor" href="#returns-3" aria-label="Permalink to "Returns""></a></h4><p><code>ComputedRef</code><<a href="./../features/feature#coercablecomponent"><code>CoercableComponent</code></a>></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L460" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:460</a></p><hr><h3 id="createlayertreenode" tabindex="-1">createLayerTreeNode <a class="header-anchor" href="#createlayertreenode" aria-label="Permalink to "createLayerTreeNode""></a></h3><p>▸ <strong>createLayerTreeNode</strong><<code>T</code>>(<code>optionsFunc</code>): <a href="./common#layertreenode"><code>LayerTreeNode</code></a><<code>T</code>></p><p>Lazily creates a tree node that's associated with a specific layer, with the given options.</p><h4 id="type-parameters-2" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-2" aria-label="Permalink to "Type parameters""></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>T</code></td><td style="text-align:left;">extends <a href="../../interfaces/data/common.LayerTreeNodeOptions"><code>LayerTreeNodeOptions</code></a></td></tr></tbody></table><h4 id="parameters-4" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-4" aria-label="Permalink to "Parameters""></a></h4><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>optionsFunc</code></td><td style="text-align:left;"><a href="./../features/feature#optionsfunc"><code>OptionsFunc</code></a><<code>T</code>, <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>>, <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>>></td><td style="text-align:left;">A function that returns the options object for this tree node.</td></tr></tbody></table><h4 id="returns-4" tabindex="-1">Returns <a class="header-anchor" href="#returns-4" aria-label="Permalink to "Returns""></a></h4><p><a href="./common#layertreenode"><code>LayerTreeNode</code></a><<code>T</code>></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L213" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:213</a></p><hr><h3 id="createresetbutton" tabindex="-1">createResetButton <a class="header-anchor" href="#createresetbutton" aria-label="Permalink to "createResetButton""></a></h3><p>▸ <strong>createResetButton</strong><<code>T</code>>(<code>optionsFunc</code>): <a href="./common#resetbutton"><code>ResetButton</code></a><<code>T</code>></p><p>Lazily creates a reset button with the given options.</p><h4 id="type-parameters-3" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-3" aria-label="Permalink to "Type parameters""></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>T</code></td><td style="text-align:left;">extends <a href="../../interfaces/features/clickables/clickable.ClickableOptions"><code>ClickableOptions</code></a> & <a href="../../interfaces/data/common.ResetButtonOptions"><code>ResetButtonOptions</code></a></td></tr></tbody></table><h4 id="parameters-5" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-5" aria-label="Permalink to "Parameters""></a></h4><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>optionsFunc</code></td><td style="text-align:left;"><a href="./../features/feature#optionsfunc"><code>OptionsFunc</code></a><<code>T</code>, <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>>, <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a><<code>string</code>, <code>unknown</code>>></td><td style="text-align:left;">A function that returns the options object for this reset button.</td></tr></tbody></table><h4 id="returns-5" tabindex="-1">Returns <a class="header-anchor" href="#returns-5" aria-label="Permalink to "Returns""></a></h4><p><a href="./common#resetbutton"><code>ResetButton</code></a><<code>T</code>></p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L99" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:99</a></p><hr><h3 id="estimatetime" tabindex="-1">estimateTime <a class="header-anchor" href="#estimatetime" aria-label="Permalink to "estimateTime""></a></h3><p>▸ <strong>estimateTime</strong>(<code>resource</code>, <code>rate</code>, <code>target</code>): <code>ComputedRef</code><<code>string</code>></p><p>Utility function for getting an ETA for when a target will be reached by a resource with a known (and assumed consistent) gain.</p><h4 id="parameters-6" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-6" aria-label="Permalink to "Parameters""></a></h4><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>resource</code></td><td style="text-align:left;"><a href="../../interfaces/features/resources/resource.Resource"><code>Resource</code></a><<a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></td><td style="text-align:left;">The resource that will be increasing over time.</td></tr><tr><td style="text-align:left;"><code>rate</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a><<a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></td><td style="text-align:left;">The rate at which the resource is increasing.</td></tr><tr><td style="text-align:left;"><code>target</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a><<a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></td><td style="text-align:left;">The target amount of the resource to estimate the duration until.</td></tr></tbody></table><h4 id="returns-6" tabindex="-1">Returns <a class="header-anchor" href="#returns-6" aria-label="Permalink to "Returns""></a></h4><p><code>ComputedRef</code><<code>string</code>></p><h4 id="defined-in-10" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-10" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L434" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:434</a></p><hr><h3 id="modifiertoformula" tabindex="-1">modifierToFormula <a class="header-anchor" href="#modifiertoformula" aria-label="Permalink to "modifierToFormula""></a></h3><p>▸ <strong>modifierToFormula</strong><<code>T</code>>(<code>modifier</code>, <code>base</code>): <code>T</code></p><p>Utility for converting a modifier into a formula. Takes the input for this formula as the base parameter.</p><h4 id="type-parameters-4" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-4" aria-label="Permalink to "Type parameters""></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>T</code></td><td style="text-align:left;">extends <a href="../../classes/game/formulas/formulas.default"><code>default</code></a><<code>any</code>, <code>T</code>></td></tr></tbody></table><h4 id="parameters-7" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-7" aria-label="Permalink to "Parameters""></a></h4><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>modifier</code></td><td style="text-align:left;"><a href="./../util/common#withrequired"><code>WithRequired</code></a><<a href="../../interfaces/game/modifiers.Modifier"><code>Modifier</code></a>, <code>"revert"</code>></td><td style="text-align:left;">The modifier to convert to the formula</td></tr><tr><td style="text-align:left;"><code>base</code></td><td style="text-align:left;"><code>T</code></td><td style="text-align:left;">An existing formula or processed DecimalSource that will be the input to the formula</td></tr></tbody></table><h4 id="returns-7" tabindex="-1">Returns <a class="header-anchor" href="#returns-7" aria-label="Permalink to "Returns""></a></h4><p><code>T</code></p><h4 id="defined-in-11" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-11" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L500" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:500</a></p><p>▸ <strong>modifierToFormula</strong>(<code>modifier</code>, <code>base</code>): <a href="./../game/formulas/types#genericformula"><code>GenericFormula</code></a></p><h4 id="parameters-8" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-8" aria-label="Permalink to "Parameters""></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>modifier</code></td><td style="text-align:left;"><a href="../../interfaces/game/modifiers.Modifier"><code>Modifier</code></a></td></tr><tr><td style="text-align:left;"><code>base</code></td><td style="text-align:left;"><a href="./../game/formulas/types#formulasource"><code>FormulaSource</code></a></td></tr></tbody></table><h4 id="returns-8" tabindex="-1">Returns <a class="header-anchor" href="#returns-8" aria-label="Permalink to "Returns""></a></h4><p><a href="./../game/formulas/types#genericformula"><code>GenericFormula</code></a></p><h4 id="defined-in-12" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-12" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/data/common.tsx#L504" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:504</a></p>',125),c=[d];function l(n,i,s,h,f,u){return a(),t("div",null,c)}const b=e(r,[["render",l]]);export{p as __pageData,b as default};
|