profectus-docs/assets/api_modules_features_clickables_clickable.md.354b1f4d.js

import{_ as e,c as t,o as a,a as l}from"./app.8e8712eb.js";const p='{"title":"Module: features/clickables/clickable","description":"","frontmatter":{},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type aliases","slug":"type-aliases"},{"level":3,"title":"Clickable","slug":"clickable"},{"level":3,"title":"GenericClickable","slug":"genericclickable"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"ClickableType","slug":"clickabletype"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createClickable","slug":"createclickable"},{"level":3,"title":"setupAutoClick","slug":"setupautoclick"}],"relativePath":"api/modules/features/clickables/clickable.md"}',c={},i=l('<h1 id="module-features-clickables-clickable" tabindex="-1">Module: features/clickables/clickable <a class="header-anchor" href="#module-features-clickables-clickable" 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/clickables/clickable.BaseClickable">BaseClickable</a></li><li><a href="../../../interfaces/features/clickables/clickable.ClickableOptions">ClickableOptions</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="clickable" tabindex="-1">Clickable <a class="header-anchor" href="#clickable" aria-hidden="true">#</a></h3><p>\u01AC <strong>Clickable</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/clickables/clickable.BaseClickable"><code>BaseClickable</code></a>, { <code>canClick</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;canClick&quot;</code>], <code>true</code>&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>display</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;display&quot;</code>]&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>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/clickables/clickable.ClickableOptions"><code>ClickableOptions</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/305946e/src/features/clickables/clickable.ts#L51" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:51</a></p><hr><h3 id="genericclickable" tabindex="-1">GenericClickable <a class="header-anchor" href="#genericclickable" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericClickable</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./clickable.html#clickable"><code>Clickable</code></a>&lt;<a href="../../../interfaces/features/clickables/clickable.ClickableOptions"><code>ClickableOptions</code></a>&gt;, { <code>canClick</code>: <a href="./../../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&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-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/305946e/src/features/clickables/clickable.ts#L63" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:63</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="clickabletype" tabindex="-1">ClickableType <a class="header-anchor" href="#clickabletype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>ClickableType</strong>: typeof <a href="./clickable.html#clickabletype"><code>ClickableType</code></a></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/305946e/src/features/clickables/clickable.ts#L24" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:24</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createclickable" tabindex="-1">createClickable <a class="header-anchor" href="#createclickable" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createClickable</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <a href="./clickable.html#clickable"><code>Clickable</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/clickables/clickable.ClickableOptions"><code>ClickableOptions</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;">() =&gt; <code>T</code> &amp; <code>ThisType</code>&lt;<a href="./clickable.html#clickable"><code>Clickable</code></a>&lt;<code>T</code>&gt;&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="./clickable.html#clickable"><code>Clickable</code></a>&lt;<code>T</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/305946e/src/features/clickables/clickable.ts#L71" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:71</a></p><hr><h3 id="setupautoclick" tabindex="-1">setupAutoClick <a class="header-anchor" href="#setupautoclick" aria-hidden="true">#</a></h3><p>\u25B8 <strong>setupAutoClick</strong>(<code>layer</code>, <code>clickable</code>, <code>autoActive?</code>): <code>Unsubscribe</code></p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-hidden="true">#</a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Default value</th></tr></thead><tbody><tr><td style="text-align:left;"><code>layer</code></td><td style="text-align:left;"><a href="./../../game/layers.html#genericlayer"><code>GenericLayer</code></a></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>clickable</code></td><td style="text-align:left;"><a href="./clickable.html#genericclickable"><code>GenericClickable</code></a></td><td style="text-align:left;"><code>undefined</code></td></tr><tr><td style="text-align:left;"><code>autoActive</code></td><td style="text-align:left;"><a href="./../../util/computed.html#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</td><td style="text-align:left;"><code>true</code></td></tr></tbody></table><h4 id="returns-1" tabindex="-1">Returns <a class="header-anchor" href="#returns-1" aria-hidden="true">#</a></h4><p><code>Unsubscribe</code></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/305946e/src/features/clickables/clickable.ts#L137" target="_blank" rel="noopener noreferrer">profectus/src/features/clickables/clickable.ts:137</a></p>',40),d=[i];function r(o,s,n,h,b,u){return a(),t("div",null,d)}var k=e(c,[["render",r]]);export{p as __pageData,k as default};