profectus-docs/assets/api_modules_game_requirements.md.36cf041b.js

2 lines
19 KiB
JavaScript
Raw Normal View History

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const q=JSON.parse('{"title":"Module: game/requirements","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/game/requirements.md","lastUpdated":null}'),i={name:"api/modules/game/requirements.md"},n=r('<h1 id="module-game-requirements" tabindex="-1">Module: game/requirements <a class="header-anchor" href="#module-game-requirements" aria-label="Permalink to &quot;Module: game/requirements&quot;"></a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;"></a></h2><ul><li><a href="../../interfaces/game/requirements.CostRequirementOptions">CostRequirementOptions</a></li><li><a href="../../interfaces/game/requirements.Requirement">Requirement</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;"></a></h2><h3 id="costrequirement" tabindex="-1">CostRequirement <a class="header-anchor" href="#costrequirement" aria-label="Permalink to &quot;CostRequirement&quot;"></a></h3><p>Ƭ <strong>CostRequirement</strong>: <a href="./../features/feature#replace"><code>Replace</code></a>&lt;<a href="../../interfaces/game/requirements.Requirement"><code>Requirement</code></a> &amp; <a href="../../interfaces/game/requirements.CostRequirementOptions"><code>CostRequirementOptions</code></a>, { <code>cost</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../lib/break_eternity#decimalsource"><code>DecimalSource</code></a>&gt; | <a href="./formulas/types#genericformula"><code>GenericFormula</code></a> ; <code>requiresPay</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>spendResources</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>visibility</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../../enums/features/feature.Visibility#visible"><code>Visible</code></a> | <a href="./../../enums/features/feature.Visibility#none"><code>None</code></a> | <code>boolean</code>&gt; }&gt;</p><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/8c0a0c4/src/game/requirements.tsx#L96" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:96</a></p><hr><h3 id="requirements" tabindex="-1">Requirements <a class="header-anchor" href="#requirements" aria-label="Permalink to &quot;Requirements&quot;"></a></h3><p>Ƭ <strong>Requirements</strong>: <a href="../../interfaces/game/requirements.Requirement"><code>Requirement</code></a> | <a href="../../interfaces/game/requirements.Requirement"><code>Requirement</code></a>[]</p><p>Utility type for accepting 1 or more <a href="../../interfaces/game/requirements.Requirement">Requirement</a>s.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/8c0a0c4/src/game/requirements.tsx#L64" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:64</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-label="Permalink to &quot;Functions&quot;"></a></h2><h3 id="createbooleanrequirement" tabindex="-1">createBooleanRequirement <a class="header-anchor" href="#createbooleanrequirement" aria-label="Permalink to &quot;createBooleanRequirement&quot;"></a></h3><p> <strong>createBooleanRequirement</strong>(<code>requirement</code>, <code>display?</code>): <a href="../../interfaces/game/requirements.Requirement"><code>Requirement</code></a></p><p>Creates a requi