ProfectusInterface: ActionOptions
features/action.ActionOptions
An object that configures a Action.
Hierarchy
Omit<ClickableOptions,"onClick"|"onHold">↳
ActionOptions
Properties
autoStart
• Optional autoStart: Computable<boolean>
Whether or not the action should perform automatically when the cooldown is finished.
Defined in
profectus/src/features/action.tsx:45
barOptions
• Optional barOptions: Partial<BarOptions>
A pass-through to the Bar used to display the cooldown progress for the action.
Defined in
profectus/src/features/action.tsx:49
canClick
• Optional canClick: Computable<boolean>
Whether or not the clickable may be clicked.
Inherited from
Omit.canClick
Defined in
profectus/src/features/clickables/clickable.ts:32
classes
• Optional classes: Computable<Record<string, boolean>>
Dictionary of CSS classes to apply to this feature.
Inherited from
Omit.classes
Defined in
profectus/src/features/clickables/clickable.ts:34
display
• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; title?: CoercableComponent }>
The display to use for this clickable.
Inherited from
Omit.display
Defined in
profectus/src/features/clickables/clickable.ts:40
duration
• duration: Computable<DecimalSource>
The cooldown during which the action cannot be performed again, in seconds.
Defined in
profectus/src/features/action.tsx:43
mark
• Optional mark: Computable<string | boolean>
Shows a marker on the corner of the feature.
Inherited from
Omit.mark
Defined in
profectus/src/features/clickables/clickable.ts:38
onClick
• onClick: (amount: DecimalSource) => void
Type declaration
▸ (amount): void
A function that is called when the action is clicked.
Parameters
| Name | Type |
|---|---|
amount | DecimalSource |
Returns
void
Defined in
profectus/src/features/action.tsx:47
small
• Optional small: boolean
Toggles a smaller design for the feature.
Inherited from
Omit.small
Defined in
profectus/src/features/clickables/clickable.ts:50
style
• Optional style: Computable<StyleValue>
CSS to apply to this feature.
Inherited from
Omit.style
Defined in
profectus/src/features/clickables/clickable.ts:36
visibility
• Optional visibility: Computable<boolean | Visibility>
Whether this clickable should be visible.
Inherited from
Omit.visibility