Profectus

Profectus / data/common / ResetButton

Interface: ResetButton ​

A button that is used to control a conversion. It will show how much can be converted currently, and can show when that amount will go up, as well as handle only being clickable when a sufficient amount of currency can be gained. Assumes this button is associated with a specific node on a tree, and triggers that tree's reset propagation.

Extends ​

Properties ​

[VueFeature] ​

[VueFeature]: true

Used to identify Vue Features

Inherited from ​

Clickable.[VueFeature]

Defined in ​

profectus/src/util/vue.tsx:43

canClick ​

canClick: MaybeRef<boolean>

Whether or not the clickable may be clicked.

Inherited from ​

Clickable.canClick

Defined in ​

profectus/src/features/clickables/clickable.tsx:47

classes? ​

optional classes: MaybeRef<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

Clickable.classes

Defined in ​

profectus/src/util/vue.tsx:35

components ​

components: MaybeGetter<Renderable>[]

The components to render inside the vue feature

Inherited from ​

Clickable.components

Defined in ​

profectus/src/util/vue.tsx:39

conversion ​

conversion: Conversion

The conversion the button uses to calculate how much resources will be gained on click

Defined in ​

profectus/src/data/common.tsx:67

display? ​

optional display: MaybeGetter<Renderable>

The display to use for this clickable.

Inherited from ​

Clickable.display

Defined in ​

profectus/src/features/clickables/clickable.tsx:49

id ​

id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Inherited from ​

Clickable.id

Defined in ​

profectus/src/util/vue.tsx:31

minimumGain? ​

optional minimumGain: MaybeRef<DecimalSource>

When canClick is left to its default, minimumGain is used to only enable the reset button when a sufficient amount of currency to gain is available.

Defined in ​

profectus/src/data/common.tsx:82

onClick()? ​

optional onClick: (e?) => void

A function that is called when the clickable is clicked.

Parameters ​

e? ​

MouseEvent | TouchEvent

Returns ​

void

Inherited from ​

Clickable.onClick

Defined in ​

profectus/src/features/clickables/clickable.tsx:43

onHold? ​

optional onHold: VoidFunction

A function that is called when the clickable is held down.

Inherited from ​

Clickable.onHold

Defined in ​

profectus/src/features/clickables/clickable.tsx:45

resetDescription? ​

optional resetDescription: MaybeRef<string>

Text to display on low conversion amounts, describing what "resetting" is in this context. Defaults to "Reset for ".

Defined in ​

profectus/src/data/common.tsx:76

resetTime? ​

optional resetTime: Persistent<DecimalSource>

A persistent ref to track how much time has passed since the last time this tree node was reset.

Defined in ​

profectus/src/data/common.tsx:84

showNextAt? ​

optional showNextAt: MaybeRef<boolean>

Whether or not to show how much currency would be required to make the gain amount increase.

Defined in ​

profectus/src/data/common.tsx:78

style? ​

optional style: MaybeRef<CSSProperties>

CSS to apply to this feature.

Inherited from ​

Clickable.style

Defined in ​

profectus/src/util/vue.tsx:37

tree ​

tree: Tree

The tree this reset button is apart of

Defined in ​

profectus/src/data/common.tsx:69

treeNode ​

treeNode: TreeNode

The specific tree node associated with this reset button

Defined in ​

profectus/src/data/common.tsx:71

type ​

type: typeof ClickableType

A symbol that helps identify features of the same type.

Inherited from ​

Clickable.type

Defined in ​

profectus/src/features/clickables/clickable.tsx:51

visibility? ​

optional visibility: MaybeRef<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

Clickable.visibility

Defined in ​

profectus/src/util/vue.tsx:33

wrappers ​

wrappers: Wrapper[]

The components to render wrapped around the vue feature

Inherited from ​

Clickable.wrappers

Defined in ​

profectus/src/util/vue.tsx:41