Skip to content
On this page

Interface: BaseRepeatable

features/repeatable.BaseRepeatable

The properties that are added onto a processed RepeatableOptions to create a Repeatable.

Properties

[Component]

[Component]: GenericComponent

The Vue component used to render this feature.

Defined in

profectus/src/features/repeatable.tsx:97


[GatherProps]

[GatherProps]: () => Record<string, unknown>

Type declaration

▸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns

Record<string, unknown>

Defined in

profectus/src/features/repeatable.tsx:99


amount

amount: Persistent<DecimalSource>

The current amount this repeatable has.

Defined in

profectus/src/features/repeatable.tsx:82


amountToIncrease

amountToIncrease: Ref<DecimalSource>

How much amount can be increased by, or 1 if unclickable. Capped at 1 if maximize is false.

Defined in

profectus/src/features/repeatable.tsx:91


canClick

canClick: ProcessedComputable<boolean>

Whether or not this repeatable can be clicked.

Defined in

profectus/src/features/repeatable.tsx:86


id

id: string

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

Defined in

profectus/src/features/repeatable.tsx:80


maxed

maxed: Ref<boolean>

Whether or not this repeatable's amount is at it's limit.

Defined in

profectus/src/features/repeatable.tsx:84


onClick

onClick: (event?: MouseEvent | TouchEvent) => void

Type declaration

▸ (event?): void

A function that gets called when this repeatable is clicked.

Parameters
NameType
event?MouseEvent | TouchEvent
Returns

void

Defined in

profectus/src/features/repeatable.tsx:93


type

type: typeof RepeatableType

A symbol that helps identify features of the same type.

Defined in

profectus/src/features/repeatable.tsx:95