1 line
4.9 KiB
JavaScript
1 line
4.9 KiB
JavaScript
import{_ as e,c as r,o as a,N as t}from"./chunks/framework.0799945b.js";const m=JSON.parse('{"title":"Interface: Resource<T>","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/resources/resource.Resource.md","lastUpdated":null}'),o={name:"api/interfaces/features/resources/resource.Resource.md"},i=t('<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><a href="./../../../modules/features/resources/resource">features/resources/resource</a>.Resource</p><p>An object that represents a named and quantifiable resource in the game.</p><h2 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to "Type parameters""></a></h2><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;"><a href="./../../../modules/util/bignum#decimalsource"><code>DecimalSource</code></a></td></tr></tbody></table><h2 id="hierarchy" tabindex="-1">Hierarchy <a class="header-anchor" href="#hierarchy" aria-label="Permalink to "Hierarchy""></a></h2><ul><li><p><code>Ref</code><<code>T</code>></p><p>↳ <strong><code>Resource</code></strong></p></li></ul><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><p>• <strong>[RefSymbol]</strong>: <code>true</code></p><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>Ref.__@RefSymbol@312</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:202</p><hr><h3 id="displayname" tabindex="-1">displayName <a class="header-anchor" href="#displayname" aria-label="Permalink to "displayName""></a></h3><p>• <strong>displayName</strong>: <code>string</code></p><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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/resources/resource.ts#L14" target="_blank" rel="noreferrer">profectus/src/features/resources/resource.ts:14</a></p><hr><h3 id="precision" tabindex="-1">precision <a class="header-anchor" href="#precision" aria-label="Permalink to "precision""></a></h3><p>• <strong>precision</strong>: <code>number</code></p><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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/resources/resource.ts#L16" target="_blank" rel="noreferrer">profectus/src/features/resources/resource.ts:16</a></p><hr><h3 id="small" tabindex="-1">small <a class="header-anchor" href="#small" aria-label="Permalink to "small""></a></h3><p>• <code>Optional</code> <strong>small</strong>: <code>boolean</code></p><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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/resources/resource.ts#L18" target="_blank" rel="noreferrer">profectus/src/features/resources/resource.ts:18</a></p><hr><h3 id="value" tabindex="-1">value <a class="header-anchor" href="#value" aria-label="Permalink to "value""></a></h3><p>• <strong>value</strong>: <code>T</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>Ref.value</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:196</p>',40),s=[i];function n(d,c,l,h,u,f){return a(),r("div",null,s)}const b=e(o,[["render",n]]);export{m as __pageData,b as default};
|