1 line
6.2 KiB
JavaScript
1 line
6.2 KiB
JavaScript
import{_ as a,c as r,a0 as t,o}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: Resource<T>","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/resources/resource/interfaces/Resource.md","filePath":"api/features/resources/resource/interfaces/Resource.md","lastUpdated":null}'),s={name:"api/features/resources/resource/interfaces/Resource.md"};function i(n,e,c,d,l,u){return o(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/resources/resource</a> / Resource</p><h1 id="interface-resource-t" tabindex="-1">Interface: Resource<T> <a class="header-anchor" href="#interface-resource-t" aria-label="Permalink to "Interface: Resource\\<T\\>""></a></h1><p>An object that represents a named and quantifiable resource in the game.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to "Extends""></a></h2><ul><li><a href="https://vuejs.org/guide/typescript/composition-api.html#typing-ref" target="_blank" rel="noreferrer"><code>Ref</code></a><<code>T</code>></li></ul><h2 id="type-parameters" tabindex="-1">Type Parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to "Type Parameters""></a></h2><p>• <strong>T</strong> = <a href="./../../../../util/bignum/type-aliases/DecimalSource"><code>DecimalSource</code></a></p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="refsymbol" tabindex="-1">[RefSymbol] <a class="header-anchor" href="#refsymbol" aria-label="Permalink to "\\[RefSymbol\\]""></a></h3><blockquote><p><strong>[RefSymbol]</strong>: <code>true</code></p></blockquote><p>Type differentiator only. We need this to be in public d.ts but don't want it to show up in IDE autocomplete, so we use a private Symbol instead.</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to "Inherited from""></a></h4><p><code>Ref.[RefSymbol]</code></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>node_modules/@vue/reactivity/dist/reactivity.d.ts:427</p><hr><h3 id="displayname" tabindex="-1">displayName <a class="header-anchor" href="#displayname" aria-label="Permalink to "displayName""></a></h3><blockquote><p><strong>displayName</strong>: <code>string</code></p></blockquote><p>The name of this resource.</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/features/resources/resource.ts#L13" target="_blank" rel="noreferrer">profectus/src/features/resources/resource.ts:13</a></p><hr><h3 id="precision" tabindex="-1">precision <a class="header-anchor" href="#precision" aria-label="Permalink to "precision""></a></h3><blockquote><p><strong>precision</strong>: <code>number</code></p></blockquote><p>When displaying the value of this resource, how many significant digits to display.</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/features/resources/resource.ts#L15" target="_blank" rel="noreferrer">profectus/src/features/resources/resource.ts:15</a></p><hr><h3 id="small" tabindex="-1">small? <a class="header-anchor" href="#small" aria-label="Permalink to "small?""></a></h3><blockquote><p><code>optional</code> <strong>small</strong>: <code>boolean</code></p></blockquote><p>Whether or not to display very small values using scientific notation, or rounding to 0.</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/features/resources/resource.ts#L17" target="_blank" rel="noreferrer">profectus/src/features/resources/resource.ts:17</a></p><h2 id="accessors" tabindex="-1">Accessors <a class="header-anchor" href="#accessors" aria-label="Permalink to "Accessors""></a></h2><h3 id="value" tabindex="-1">value <a class="header-anchor" href="#value" aria-label="Permalink to "value""></a></h3><h4 id="get-signature" tabindex="-1">Get Signature <a class="header-anchor" href="#get-signature" aria-label="Permalink to "Get Signature""></a></h4><blockquote><p><strong>get</strong> <strong>value</strong>(): <code>T</code></p></blockquote><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to "Returns""></a></h5><p><code>T</code></p><h4 id="set-signature" tabindex="-1">Set Signature <a class="header-anchor" href="#set-signature" aria-label="Permalink to "Set Signature""></a></h4><blockquote><p><strong>set</strong> <strong>value</strong>(<code>_</code>): <code>void</code></p></blockquote><h5 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to "Parameters""></a></h5><h6 id="" tabindex="-1">_ <a class="header-anchor" href="#" aria-label="Permalink to "\\_""></a></h6><p><code>S</code></p><h5 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to "Returns""></a></h5><p><code>void</code></p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to "Inherited from""></a></h4><p><code>Ref.value</code></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>node_modules/@vue/reactivity/dist/reactivity.d.ts:420</p>',50)]))}const p=a(s,[["render",i]]);export{f as __pageData,p as default};
|