Profectus
On this page

Interface: BaseChallenge ​

features/challenges/challenge.BaseChallenge

The properties that are added onto a processed ChallengeOptions to create a Challenge.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/challenges/challenge.tsx:114

[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/challenges/challenge.tsx:116

active ​

• active: Persistent<boolean>

Whether or not this challenge is currently active.

Defined in ​

profectus/src/features/challenges/challenge.tsx:103

canComplete ​

• canComplete: Ref<DecimalSource>

The current amount of times this challenge can be completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:95

complete ​

• complete: (remainInChallenge?: boolean) => void

Type declaration ​

▸ (remainInChallenge?): void

A function to complete this challenge.

Parameters ​
NameTypeDescription
remainInChallenge?booleanOptional parameter to specify if the challenge should remain active after completion.
Returns ​

void

Defined in ​

profectus/src/features/challenges/challenge.tsx:110

completed ​

• completed: Ref<boolean>

Whether or not this challenge has been completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:99

completions ​

• completions: Persistent<DecimalSource>

The current number of times this challenge has been completed.

Defined in ​

profectus/src/features/challenges/challenge.tsx:97

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/challenges/challenge.tsx:93

maxed ​

• maxed: Ref<boolean>

Whether or not this challenge's completion count is at its limit.

Defined in ​

profectus/src/features/challenges/challenge.tsx:101

toggle ​

• toggle: VoidFunction

A function to enter or leave the challenge.

Defined in ​

profectus/src/features/challenges/challenge.tsx:105

type ​

• type: typeof ChallengeType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/challenges/challenge.tsx:112