ProfectusInterface: ResetButtonOptions
data/common.ResetButtonOptions
An object that configures a ResetButton
Hierarchy
↳
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
Defined in
profectus/src/data/common.tsx:52
classes
• Optional classes: Computable<Record<string, boolean>>
Inherited from
Defined in
profectus/src/features/clickables/clickable.ts:21
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:31
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
Defined in
profectus/src/data/common.tsx:47
mark
• Optional mark: Computable<string | boolean>
Inherited from
Defined in
profectus/src/features/clickables/clickable.ts:23
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:56
onClick
• Optional onClick: (e?: MouseEvent | TouchEvent) => void
Type declaration
▸ (e?): void
Parameters
| Name | Type |
|---|---|
e? | MouseEvent | TouchEvent |
Returns
void
Inherited from
Defined in
profectus/src/features/clickables/clickable.ts:32
onHold
• Optional onHold: VoidFunction
Inherited from
Defined in
profectus/src/features/clickables/clickable.ts:33
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:40
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:58
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:42
small
• Optional small: boolean
Inherited from
Defined in
profectus/src/features/clickables/clickable.ts:31
style
• Optional style: Computable<StyleValue>
Inherited from
Defined in
profectus/src/features/clickables/clickable.ts:22
tree
• tree: GenericTree
The tree this reset button is apart of
Defined in
profectus/src/data/common.tsx:33
treeNode
• treeNode: GenericTreeNode
The specific tree node associated with this reset button
Defined in
profectus/src/data/common.tsx:35
visibility
• Optional visibility: Computable<Visibility>