import{_ as e,c as t,o as a,N as l}from"./chunks/framework.0799945b.js";const p=JSON.parse('{"title":"Module: features/clickables/clickable","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/clickables/clickable.md","lastUpdated":null}'),c={name:"api/modules/features/clickables/clickable.md"},i=l('

Module: features/clickables/clickable ​

Components ​

Interfaces ​

Type Aliases ​

Clickable ​

Ƭ Clickable<T>: Replace<T & BaseClickable, { canClick: GetComputableTypeWithDefault<T["canClick"], true> ; classes: GetComputableType<T["classes"]> ; display: GetComputableType<T["display"]> ; mark: GetComputableType<T["mark"]> ; style: GetComputableType<T["style"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>

An object that represents a feature that can be clicked or held down.

Type parameters ​

NameType
Textends ClickableOptions

Defined in ​

profectus/src/features/clickables/clickable.ts:72

GenericClickable ​

Ƭ GenericClickable: Replace<Clickable<ClickableOptions>, { canClick: ProcessedComputable<boolean> ; visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Clickable object.

Defined in ​

profectus/src/features/clickables/clickable.ts:85

Variables ​

ClickableType ​

• Const ClickableType: typeof ClickableType

A symbol used to identify Clickable features.

Defined in ​

profectus/src/features/clickables/clickable.ts:23

Functions ​

createClickable ​

▸ createClickable<T>(optionsFunc?): Clickable<T>

Lazily creates a clickable with the given options.

Type parameters ​

NameType
Textends ClickableOptions

Parameters ​

NameTypeDescription
optionsFunc?OptionsFunc<T, BaseClickable, GenericClickable>Clickable options.

Returns ​

Clickable<T>

Defined in ​

profectus/src/features/clickables/clickable.ts:97

setupAutoClick ​

▸ setupAutoClick(layer, clickable, autoActive?): Unsubscribe

Utility to auto click a clickable whenever it can be.

Parameters ​

NameTypeDefault valueDescription
layerBaseLayerundefinedThe layer the clickable is apart of
clickableGenericClickableundefinedThe clicker to click automatically
autoActiveComputable<boolean>trueWhether or not the clickable should currently be auto-clicking

Returns ​

Unsubscribe

Defined in ​

profectus/src/features/clickables/clickable.ts:169

',47),o=[i];function r(d,s,n,b,h,u){return a(),t("div",null,o)}const k=e(c,[["render",r]]);export{p as __pageData,k as default};