Profectus / features/clickables/action / ActionOptions
Interface: ActionOptions ​
An object that configures an Action.
Extends ​
Omit
<ClickableOptions
,"onClick"
|"onHold"
>
Properties ​
autoStart? ​
optional
autoStart:MaybeRefOrGetter
<boolean
>
Whether or not the action should perform automatically when the cooldown is finished.
Defined in ​
profectus/src/features/clickables/action.tsx:25
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/clickables/action.tsx:29
canClick? ​
optional
canClick:MaybeRefOrGetter
<boolean
>
Whether or not the clickable may be clicked.
Inherited from ​
Omit.canClick
Defined in ​
profectus/src/features/clickables/clickable.tsx:24
classes? ​
optional
classes:MaybeRefOrGetter
<Record
<string
,boolean
>>
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Omit.classes
Defined in ​
display? ​
optional
display:MaybeGetter
<Renderable
> | {description
:MaybeGetter
<Renderable
>;title
: MaybeGetter<Renderable> | undefined; }
The display to use for this clickable.
Type declaration ​
{ description
: MaybeGetter
<Renderable
>; title
: MaybeGetter<Renderable> | undefined; }
description ​
description:
MaybeGetter
<Renderable
>
The main text that appears in the display.
title? ​
optional
title: MaybeGetter<Renderable> | undefined
A header to appear at the top of the display.
Inherited from ​
Omit.display
Defined in ​
profectus/src/features/clickables/clickable.tsx:26
duration ​
duration:
MaybeRefOrGetter
<DecimalSource
>
The cooldown during which the action cannot be performed again, in seconds.
Defined in ​
profectus/src/features/clickables/action.tsx:23
onClick() ​
onClick: (
amount
) =>void
A function that is called when the action is clicked.
Parameters ​
amount ​
Returns ​
void
Defined in ​
profectus/src/features/clickables/action.tsx:27
style? ​
optional
style:MaybeRefOrGetter
<CSSProperties
>
CSS to apply to this feature.
Inherited from ​
Omit.style
Defined in ​
visibility? ​
optional
visibility:MaybeRefOrGetter
<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Omit.visibility