profectus-docs/assets/api_modules_features_buyable.md.762147f7.js

1 line
8.9 KiB
JavaScript

import{_ as e,c as t,o as a,a as o}from"./app.ab34650d.js";const f=JSON.parse('{"title":"Module: features/buyable","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type Aliases","slug":"type-aliases"},{"level":3,"title":"Buyable","slug":"buyable"},{"level":3,"title":"BuyableDisplay","slug":"buyabledisplay"},{"level":3,"title":"GenericBuyable","slug":"genericbuyable"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"BuyableType","slug":"buyabletype"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createBuyable","slug":"createbuyable"}],"relativePath":"api/modules/features/buyable.md","lastUpdated":null}'),l={name:"api/modules/features/buyable.md"},c=o('<h1 id="module-features-buyable" tabindex="-1">Module: features/buyable <a class="header-anchor" href="#module-features-buyable" aria-hidden="true">#</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-hidden="true">#</a></h2><ul><li><a href="../../interfaces/features/buyable.BaseBuyable">BaseBuyable</a></li><li><a href="../../interfaces/features/buyable.BuyableOptions">BuyableOptions</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="buyable" tabindex="-1">Buyable <a class="header-anchor" href="#buyable" aria-hidden="true">#</a></h3><p>\u01AC <strong>Buyable</strong>&lt;<code>T</code>&gt;: <a href="./feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../interfaces/features/buyable.BaseBuyable"><code>BaseBuyable</code></a>, { <code>canPurchase</code>: <a href="./../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;canPurchase&quot;</code>], <code>Ref</code>&lt;<code>boolean</code>&gt;&gt; ; <code>classes</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>cost</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;cost&quot;</code>]&gt; ; <code>display</code>: <code>Ref</code>&lt;<a href="./feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt; ; <code>mark</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;mark&quot;</code>]&gt; ; <code>purchaseLimit</code>: <a href="./../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;purchaseLimit&quot;</code>], <a href="../../classes/lib/break_eternity.default"><code>default</code></a>&gt; ; <code>resource</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;resource&quot;</code>]&gt; ; <code>small</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;small&quot;</code>]&gt; ; <code>style</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; ; <code>visibility</code>: <a href="./../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../enums/features/feature.Visibility.html#visible"><code>Visible</code></a>&gt; }&gt;</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</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/buyable.BuyableOptions"><code>BuyableOptions</code></a></td></tr></tbody></table><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/buyable.tsx#L59" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:59</a></p><hr><h3 id="buyabledisplay" tabindex="-1">BuyableDisplay <a class="header-anchor" href="#buyabledisplay" aria-hidden="true">#</a></h3><p>\u01AC <strong>BuyableDisplay</strong>: <a href="./feature.html#coercablecomponent"><code>CoercableComponent</code></a> | { <code>description?</code>: <a href="./feature.html#coercablecomponent"><code>CoercableComponent</code></a> ; <code>effectDisplay?</code>: <a href="./feature.html#coercablecomponent"><code>CoercableComponent</code></a> ; <code>showAmount?</code>: <code>boolean</code> ; <code>title?</code>: <a href="./feature.html#coercablecomponent"><code>CoercableComponent</code></a> }</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/buyable.tsx#L23" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:23</a></p><hr><h3 id="genericbuyable" tabindex="-1">GenericBuyable <a class="header-anchor" href="#genericbuyable" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericBuyable</strong>: <a href="./feature.html#replace"><code>Replace</code></a>&lt;<a href="./buyable.html#buyable"><code>Buyable</code></a>&lt;<a href="../../interfaces/features/buyable.BuyableOptions"><code>BuyableOptions</code></a>&gt;, { <code>canPurchase</code>: <a href="./../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt; ; <code>purchaseLimit</code>: <a href="./../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../util/bignum.html#decimalsource"><code>DecimalSource</code></a>&gt; ; <code>visibility</code>: <a href="./../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt; }&gt;</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/buyable.tsx#L75" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:75</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="buyabletype" tabindex="-1">BuyableType <a class="header-anchor" href="#buyabletype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>BuyableType</strong>: typeof <a href="./buyable.html#buyabletype"><code>BuyableType</code></a></p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/buyable.tsx#L21" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:21</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createbuyable" tabindex="-1">createBuyable <a class="header-anchor" href="#createbuyable" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createBuyable</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <a href="./buyable.html#buyable"><code>Buyable</code></a>&lt;<code>T</code>&gt;</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-hidden="true">#</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/buyable.BuyableOptions"><code>BuyableOptions</code></a></td></tr></tbody></table><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</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>optionsFunc</code></td><td style="text-align:left;"><a href="./feature.html#optionsfunc"><code>OptionsFunc</code></a>&lt;<code>T</code>, <a href="../../interfaces/features/buyable.BaseBuyable"><code>BaseBuyable</code></a>, <a href="./buyable.html#genericbuyable"><code>GenericBuyable</code></a>&gt;</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><a href="./buyable.html#buyable"><code>Buyable</code></a>&lt;<code>T</code>&gt;</p>',34),d=[c];function r(u,s,i,b,n,h){return a(),t("div",null,d)}var y=e(l,[["render",r]]);export{f as __pageData,y as default};