1 line
9.3 KiB
JavaScript
1 line
9.3 KiB
JavaScript
import{_ as a,c as r,a0 as t,o as i}from"./chunks/framework.P9qPzDnn.js";const m=JSON.parse('{"title":"Interface: Requirement","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/game/requirements/interfaces/Requirement.md","filePath":"api/game/requirements/interfaces/Requirement.md","lastUpdated":null}'),n={name:"api/game/requirements/interfaces/Requirement.md"};function o(s,e,l,c,d,u){return i(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../">Profectus</a> / <a href="./../">game/requirements</a> / Requirement</p><h1 id="interface-requirement" tabindex="-1">Interface: Requirement <a class="header-anchor" href="#interface-requirement" aria-label="Permalink to "Interface: Requirement""></a></h1><p>An object that can be used to describe a requirement to perform some purchase or other action.</p><h2 id="see" tabindex="-1">See <a class="header-anchor" href="#see" aria-label="Permalink to "See""></a></h2><p><a href="./../functions/createCostRequirement">createCostRequirement</a></p><h2 id="extended-by" tabindex="-1">Extended by <a class="header-anchor" href="#extended-by" aria-label="Permalink to "Extended by""></a></h2><ul><li><a href="./CostRequirement"><code>CostRequirement</code></a></li></ul><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><blockquote><p><code>optional</code> <strong>canMaximize</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>boolean</code>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/requirements.tsx#L40" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:40</a></p><hr><h3 id="display" tabindex="-1">display()? <a class="header-anchor" href="#display" aria-label="Permalink to "display()?""></a></h3><blockquote><p><code>optional</code> <strong>display</strong>: (<code>amount</code>?) => <a href="./../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a></p></blockquote><p>The display for this specific requirement. Required if <a href="./Requirement#visibility">visibility</a> can be <a href="./../../../features/feature/enumerations/Visibility#visible">Visibility.Visible</a>.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h4><h5 id="amount" tabindex="-1">amount? <a class="header-anchor" href="#amount" aria-label="Permalink to "amount?""></a></h5><p><a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h4><p><a href="./../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a></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/game/requirements.tsx#L24" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:24</a></p><hr><h3 id="partialdisplay" tabindex="-1">partialDisplay()? <a class="header-anchor" href="#partialdisplay" aria-label="Permalink to "partialDisplay()?""></a></h3><blockquote><p><code>optional</code> <strong>partialDisplay</strong>: (<code>amount</code>?) => <a href="./../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a></p></blockquote><p>The display for this specific requirement. This is used for displays multiple requirements condensed. Required if <a href="./Requirement#visibility">visibility</a> can be <a href="./../../../features/feature/enumerations/Visibility#visible">Visibility.Visible</a>.</p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to "Parameters""></a></h4><h5 id="amount-1" tabindex="-1">amount? <a class="header-anchor" href="#amount-1" aria-label="Permalink to "amount?""></a></h5><p><a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h4><p><a href="./../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a></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/game/requirements.tsx#L20" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:20</a></p><hr><h3 id="pay" tabindex="-1">pay()? <a class="header-anchor" href="#pay" aria-label="Permalink to "pay()?""></a></h3><blockquote><p><code>optional</code> <strong>pay</strong>: (<code>amount</code>?) => <code>void</code></p></blockquote><p>Perform any effects to the game state that should happen when the requirement gets triggered.</p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-label="Permalink to "Parameters""></a></h4><h5 id="amount-2" tabindex="-1">amount? <a class="header-anchor" href="#amount-2" aria-label="Permalink to "amount?""></a></h5><p><a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><p>The amount of levels of requirements to pay for.</p><h4 id="returns-2" tabindex="-1">Returns <a class="header-anchor" href="#returns-2" aria-label="Permalink to "Returns""></a></h4><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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/requirements.tsx#L45" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:45</a></p><hr><h3 id="requirementmet" tabindex="-1">requirementMet <a class="header-anchor" href="#requirementmet" aria-label="Permalink to "requirementMet""></a></h3><blockquote><p><strong>requirementMet</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>boolean</code> | <a href="./../../../lib/break_eternity/type-aliases/DecimalSource"><code>DecimalSource</code></a>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/requirements.tsx#L32" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:32</a></p><hr><h3 id="requirespay" tabindex="-1">requiresPay <a class="header-anchor" href="#requirespay" aria-label="Permalink to "requiresPay""></a></h3><blockquote><p><strong>requiresPay</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>boolean</code>></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/requirements.tsx#L36" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:36</a></p><hr><h3 id="visibility" tabindex="-1">visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to "visibility""></a></h3><blockquote><p><strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>boolean</code> | <a href="./../../../features/feature/enumerations/Visibility"><code>Visibility</code></a>></p></blockquote><p>Whether or not this requirement should be displayed in Vue Features. <a href="./../functions/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://code.incremental.social/profectus/Profectus/src/branch/main/src/game/requirements.tsx#L28" target="_blank" rel="noreferrer">profectus/src/game/requirements.tsx:28</a></p>',65)]))}const p=a(n,[["render",o]]);export{m as __pageData,p as default};
|