1 line
9.6 KiB
JavaScript
1 line
9.6 KiB
JavaScript
import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Interface: Requirement","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/game/requirements.Requirement.md","lastUpdated":null}'),i={name:"api/interfaces/game/requirements.Requirement.md"},o=r('<h1 id="interface-requirement" tabindex="-1">Interface: Requirement <a class="header-anchor" href="#interface-requirement" aria-label="Permalink to "Interface: Requirement""></a></h1><p><a href="./../../modules/game/requirements">game/requirements</a>.Requirement</p><p>An object that can be used to describe a requirement to perform some purchase or other action.</p><p><strong><code>See</code></strong></p><p><a href="./../../modules/game/requirements#createcostrequirement">createCostRequirement</a></p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="canmaximize" tabindex="-1">canMaximize <a class="header-anchor" href="#canmaximize" aria-label="Permalink to "canMaximize""></a></h3><p>• <code>Optional</code> <strong>canMaximize</strong>: <a href="./../../modules/util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code>></p><p>Whether or not this requirement can have multiple levels of requirements that can be met at once. Requirement is assumed to not have multiple levels if this property not present.</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/game/requirements.tsx#L53" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:53</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to "display""></a></h3><p>• <code>Optional</code> <strong>display</strong>: (<code>amount?</code>: <a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>) => <code>Element</code></p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>amount?</code>): <code>Element</code></p><p>The display for this specific requirement. Required if <a href="./requirements.Requirement#visibility">visibility</a> can be Visibility.Visible.</p><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h5><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>amount?</code></td><td style="text-align:left;"><a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><code>Element</code></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/game/requirements.tsx#L37" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:37</a></p><hr><h3 id="partialdisplay" tabindex="-1">partialDisplay <a class="header-anchor" href="#partialdisplay" aria-label="Permalink to "partialDisplay""></a></h3><p>• <code>Optional</code> <strong>partialDisplay</strong>: (<code>amount?</code>: <a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>) => <code>Element</code></p><h4 id="type-declaration-1" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-1" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>amount?</code>): <code>Element</code></p><p>The display for this specific requirement. This is used for displays multiple requirements condensed. Required if <a href="./requirements.Requirement#visibility">visibility</a> can be Visibility.Visible.</p><h5 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h5><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>amount?</code></td><td style="text-align:left;"><a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h5 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h5><p><code>Element</code></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://github.com/profectus-engine/Profectus/blob/70cda5f/src/game/requirements.tsx#L33" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:33</a></p><hr><h3 id="pay" tabindex="-1">pay <a class="header-anchor" href="#pay" aria-label="Permalink to "pay""></a></h3><p>• <code>Optional</code> <strong>pay</strong>: (<code>amount?</code>: <a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>) => <code>void</code></p><h4 id="type-declaration-2" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration-2" aria-label="Permalink to "Type declaration""></a></h4><p>▸ (<code>amount?</code>): <code>void</code></p><p>Perform any effects to the game state that should happen when the requirement gets triggered.</p><h5 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to "Parameters""></a></h5><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>amount?</code></td><td style="text-align:left;"><a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a></td><td style="text-align:left;">The amount of levels of requirements to pay for.</td></tr></tbody></table><h5 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to "Returns""></a></h5><p><code>void</code></p><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/game/requirements.tsx#L58" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:58</a></p><hr><h3 id="requirementmet" tabindex="-1">requirementMet <a class="header-anchor" href="#requirementmet" aria-label="Permalink to "requirementMet""></a></h3><p>• <strong>requirementMet</strong>: <a href="./../../modules/util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code> | <a href="./../../modules/lib/break_eternity#decimalsource"><code>DecimalSource</code></a>></p><p>Whether or not this requirement has been met.</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/game/requirements.tsx#L45" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:45</a></p><hr><h3 id="requirespay" tabindex="-1">requiresPay <a class="header-anchor" href="#requirespay" aria-label="Permalink to "requiresPay""></a></h3><p>• <strong>requiresPay</strong>: <a href="./../../modules/util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code>></p><p>Whether or not this requirement will need to affect the game state when whatever is using this requirement gets triggered.</p><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/game/requirements.tsx#L49" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:49</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility""></a></h3><p>• <strong>visibility</strong>: <a href="./../../modules/util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code> | <a href="./../../enums/features/feature.Visibility#visible"><code>Visible</code></a> | <a href="./../../enums/features/feature.Visibility#none"><code>None</code></a>></p><p>Whether or not this requirement should be displayed in Vue Features. <a href="./../../modules/game/requirements#displayrequirements">displayRequirements</a> will respect this property.</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/game/requirements.tsx#L41" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:41</a></p>',65),n=[o];function s(d,l,c,h,u,m){return a(),t("div",null,n)}const b=e(i,[["render",s]]);export{f as __pageData,b as default};
|