profectus-docs/assets/api_interfaces_features_buyable.BaseBuyable.md.a812cacf.js

1 line
13 KiB
JavaScript

import{_ as e,c as o,o as d,a as c}from"./app.ab34650d.js";const b=JSON.parse('{"title":"Interface: BaseBuyable","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"[Component]","slug":"component"},{"level":3,"title":"[GatherProps]","slug":"gatherprops"},{"level":3,"title":"amount","slug":"amount"},{"level":3,"title":"canAfford","slug":"canafford"},{"level":3,"title":"canClick","slug":"canclick"},{"level":3,"title":"id","slug":"id"},{"level":3,"title":"maxed","slug":"maxed"},{"level":3,"title":"onClick","slug":"onclick"},{"level":3,"title":"purchase","slug":"purchase"},{"level":3,"title":"type","slug":"type"}],"relativePath":"api/interfaces/features/buyable.BaseBuyable.md","lastUpdated":null}'),t={name:"api/interfaces/features/buyable.BaseBuyable.md"},r=c('<h1 id="interface-basebuyable" tabindex="-1">Interface: BaseBuyable <a class="header-anchor" href="#interface-basebuyable" aria-hidden="true">#</a></h1><p><a href="./../../modules/features/buyable.html">features/buyable</a>.BaseBuyable</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-hidden="true">#</a></h3><p>\u2022 <strong>[Component]</strong>: <code>DefineComponent</code>&lt;{ <code>canClick</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt;&gt; } ; <code>classes</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;&gt; ; <code>display</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>undefined</code> | <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> | { <code>description</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> ; <code>title?</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> } | { <code>description</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> ; <code>title?</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> }&gt;&gt; } ; <code>id</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>StringConstructor</code> = String } ; <code>mark</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>string</code> | <code>boolean</code>&gt;&gt; ; <code>onClick</code>: <code>PropType</code>&lt;(<code>e?</code>: <code>MouseEvent</code> | <code>TouchEvent</code>) =&gt; <code>void</code>&gt; ; <code>onHold</code>: <code>PropType</code>&lt;<code>VoidFunction</code>&gt; ; <code>small</code>: <code>BooleanConstructor</code> = Boolean; <code>style</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;&gt; ; <code>visibility</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;&gt; } }, { <code>Visibility</code>: typeof <a href="../../enums/features/feature.Visibility"><code>Visibility</code></a> ; <code>comp</code>: <code>ShallowRef</code>&lt;<code>string</code> | <code>Component</code>&lt;<code>any</code>, <code>any</code>, <code>any</code>, <code>ComputedOptions</code>, <code>MethodOptions</code>&gt;&gt; ; <code>start</code>: (<code>e</code>: <code>MouseEvent</code> | <code>TouchEvent</code>) =&gt; <code>void</code> ; <code>stop</code>: <code>VoidFunction</code> ; <code>unref</code>: &lt;T&gt;(<code>ref</code>: <code>T</code> | <code>Ref</code>&lt;<code>T</code>&gt;) =&gt; <code>T</code> }, <code>unknown</code>, {}, {}, <code>ComponentOptionsMixin</code>, <code>ComponentOptionsMixin</code>, <code>Record</code>&lt;<code>string</code>, <code>any</code>&gt;, <code>string</code>, <code>PublicProps</code>, <code>Readonly</code>&lt;<code>ExtractPropTypes</code>&lt;{ <code>canClick</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt;&gt; } ; <code>classes</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;&gt; ; <code>display</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>undefined</code> | <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> | { <code>description</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> ; <code>title?</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> } | { <code>description</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> ; <code>title?</code>: <a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> }&gt;&gt; } ; <code>id</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>StringConstructor</code> = String } ; <code>mark</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>string</code> | <code>boolean</code>&gt;&gt; ; <code>onClick</code>: <code>PropType</code>&lt;(<code>e?</code>: <code>MouseEvent</code> | <code>TouchEvent</code>) =&gt; <code>void</code>&gt; ; <code>onHold</code>: <code>PropType</code>&lt;<code>VoidFunction</code>&gt; ; <code>small</code>: <code>BooleanConstructor</code> = Boolean; <code>style</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;&gt; ; <code>visibility</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;&gt; } }&gt;&gt;, { <code>small</code>: <code>boolean</code> = Boolean }&gt;</p><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#L55" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:55</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-hidden="true">#</a></h3><p>\u2022 <strong>[GatherProps]</strong>: () =&gt; <code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-hidden="true">#</a></h4><p>\u25B8 (): <code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h5><p><code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;</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#L56" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:56</a></p><hr><h3 id="amount" tabindex="-1">amount <a class="header-anchor" href="#amount" aria-hidden="true">#</a></h3><p>\u2022 <strong>amount</strong>: <a href="./../../modules/game/persistence.html#persistent"><code>Persistent</code></a>&lt;<a href="./../../modules/lib/break_eternity.html#decimalsource"><code>DecimalSource</code></a>&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#L48" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:48</a></p><hr><h3 id="canafford" tabindex="-1">canAfford <a class="header-anchor" href="#canafford" aria-hidden="true">#</a></h3><p>\u2022 <strong>canAfford</strong>: <code>Ref</code>&lt;<code>boolean</code>&gt;</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#L50" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:50</a></p><hr><h3 id="canclick" tabindex="-1">canClick <a class="header-anchor" href="#canclick" aria-hidden="true">#</a></h3><p>\u2022 <strong>canClick</strong>: <a href="./../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt;</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/buyable.tsx#L51" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:51</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-hidden="true">#</a></h3><p>\u2022 <strong>id</strong>: <code>string</code></p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/buyable.tsx#L47" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:47</a></p><hr><h3 id="maxed" tabindex="-1">maxed <a class="header-anchor" href="#maxed" aria-hidden="true">#</a></h3><p>\u2022 <strong>maxed</strong>: <code>Ref</code>&lt;<code>boolean</code>&gt;</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/buyable.tsx#L49" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:49</a></p><hr><h3 id="onclick" tabindex="-1">onClick <a class="header-anchor" href="#onclick" aria-hidden="true">#</a></h3><p>\u2022 <strong>onClick</strong>: <code>VoidFunction</code></p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/buyable.tsx#L52" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:52</a></p><hr><h3 id="purchase" tabindex="-1">purchase <a class="header-anchor" href="#purchase" aria-hidden="true">#</a></h3><p>\u2022 <strong>purchase</strong>: <code>VoidFunction</code></p><h4 id="defined-in-8" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-8" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/buyable.tsx#L53" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:53</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-hidden="true">#</a></h3><p>\u2022 <strong>type</strong>: typeof <a href="./../../modules/features/buyable.html#buyabletype"><code>BuyableType</code></a></p><h4 id="defined-in-9" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-9" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/features/buyable.tsx#L54" target="_blank" rel="noopener noreferrer">profectus/src/features/buyable.tsx:54</a></p>',56),a=[r];function n(s,l,i,u,p,h){return d(),o("div",null,a)}var m=e(t,[["render",n]]);export{b as __pageData,m as default};