profectus-docs/assets/api_data_common_functions_isRendered.md.C74j66m3.js

1 line
4.6 KiB
JavaScript
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as a,c as r,a0 as t,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Function: isRendered()","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/data/common/functions/isRendered.md","filePath":"api/data/common/functions/isRendered.md","lastUpdated":null}'),n={name:"api/data/common/functions/isRendered.md"};function i(d,e,l,s,c,h){return o(),r("div",null,e[0]||(e[0]=[t('<p><a href="./../../../">Profectus</a> / <a href="./../">data/common</a> / isRendered</p><h1 id="function-isrendered" tabindex="-1">Function: isRendered() <a class="header-anchor" href="#function-isrendered" aria-label="Permalink to &quot;Function: isRendered()&quot;"></a></h1><h2 id="call-signature" tabindex="-1">Call Signature <a class="header-anchor" href="#call-signature" aria-label="Permalink to &quot;Call Signature&quot;"></a></h2><blockquote><p><strong>isRendered</strong>(<code>layer</code>, <code>id</code>): <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-computed" target="_blank" rel="noreferrer"><code>ComputedRef</code></a>&lt;<code>boolean</code>&gt;</p></blockquote><p>Utility function for getting a computed boolean for whether or not a given feature is currently rendered in the DOM. Note it will have a true value even if the feature is off screen.</p><h3 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;"></a></h3><h4 id="layer" tabindex="-1">layer <a class="header-anchor" href="#layer" aria-label="Permalink to &quot;layer&quot;"></a></h4><p><a href="./../../../game/layers/interfaces/BaseLayer"><code>BaseLayer</code></a></p><p>The layer the feature appears within</p><h4 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;"></a></h4><p><code>string</code></p><p>The ID of the feature</p><h3 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;"></a></h3><p><a href="https://vuejs.org/guide/typescript/composition-api.html#typing-computed" target="_blank" rel="noreferrer"><code>ComputedRef</code></a>&lt;<code>boolean</code>&gt;</p><h3 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;"></a></h3><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/data/common.tsx#L491" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:491</a></p><h2 id="call-signature-1" tabindex="-1">Call Signature <a class="header-anchor" href="#call-signature-1" aria-label="Permalink to &quot;Call Signature&quot;"></a></h2><blockquote><p><strong>isRendered</strong>(<code>layer</code>, <code>feature</code>): <a href="https://vuejs.org/guide/typescript/composition-api.html#typing-computed" target="_blank" rel="noreferrer"><code>ComputedRef</code></a>&lt;<code>boolean</code>&gt;</p></blockquote><p>Utility function for getting a computed boolean for whether or not a given feature is currently rendered in the DOM. Note it will have a true value even if the feature is off screen.</p><h3 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-label="Permalink to &quot;Parameters&quot;"></a></h3><h4 id="layer-1" tabindex="-1">layer <a class="header-anchor" href="#layer-1" aria-label="Permalink to &quot;layer&quot;"></a></h4><p><a href="./../../../game/layers/interfaces/BaseLayer"><code>BaseLayer</code></a></p><p>The layer the feature appears within</p><h4 id="feature" tabindex="-1">feature <a class="header-anchor" href="#feature" aria-label="Permalink to &quot;feature&quot;"></a></h4><p>The feature that may be rendered</p><h5 id="id-1" tabindex="-1">id <a class="header-anchor" href="#id-1" aria-label="Permalink to &quot;id&quot;"></a></h5><p><code>string</code></p><h3 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-label="Permalink to &quot;Returns&quot;"></a></h3><p><a href="https://vuejs.org/guide/typescript/composition-api.html#typing-computed" target="_blank" rel="noreferrer"><code>ComputedRef</code></a>&lt;<code>boolean</code>&gt;</p><h3 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;"></a></h3><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/data/common.tsx#L498" target="_blank" rel="noreferrer">profectus/src/data/common.tsx:498</a></p>',31)]))}const f=a(n,[["render",i]]);export{p as __pageData,f as default};