Interface: ResetButtonOptions ​

data/common.ResetButtonOptions

An object that configures a ResetButton

Hierarchy ​

• ClickableOptions

  ↳ ResetButtonOptions

Properties ​

canClick ​

• Optional canClick: Computable<boolean>

Whether or not this button can currently be clicked. Defaults to checking the current gain amount is greater than minimumGain

Overrides ​

ClickableOptions.canClick

Defined in ​

profectus/src/data/common.tsx:57

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

ClickableOptions.classes

Defined in ​

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

conversion ​

• conversion: GenericConversion

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

Defined in ​

profectus/src/data/common.tsx:36

display ​

• Optional display: Computable<CoercableComponent>

The content to display on the button. By default, this includes the reset description, and amount of currency to be gained.

Overrides ​

ClickableOptions.display

Defined in ​

profectus/src/data/common.tsx:52

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Inherited from ​

ClickableOptions.mark

Defined in ​

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

minimumGain ​

• Optional minimumGain: Computable<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:61

onClick ​

• Optional onClick: (e?: MouseEvent | TouchEvent) => void

Type declaration ​

▸ (e?): void

A function that is called when the clickable is clicked.

Parameters ​

Returns ​

void

Inherited from ​

ClickableOptions.onClick

Defined in ​

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

onHold ​

• Optional onHold: VoidFunction

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

Inherited from ​

ClickableOptions.onHold

Defined in ​

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

resetDescription ​

• Optional resetDescription: Computable<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:45

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:63

showNextAt ​

• Optional showNextAt: Computable<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:47

small ​

• Optional small: boolean

Toggles a smaller design for the feature.

Inherited from ​

ClickableOptions.small

Defined in ​

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

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Inherited from ​

ClickableOptions.style

Defined in ​

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

tree ​

• tree: GenericTree

The tree this reset button is apart of

Defined in ​

profectus/src/data/common.tsx:38

treeNode ​

• treeNode: GenericTreeNode

The specific tree node associated with this reset button

Defined in ​

profectus/src/data/common.tsx:40

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this clickable should be visible.

Inherited from ​

ClickableOptions.visibility

Defined in ​

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