ProfectusInterface: ChallengeOptions
features/challenges/challenge.ChallengeOptions
An object that configures a Challenge.
Properties
canStart
• Optional canStart: Computable<boolean>
Whether this challenge can be started.
Defined in
profectus/src/features/challenges/challenge.tsx:49
classes
• Optional classes: Computable<Record<string, boolean>>
Dictionary of CSS classes to apply to this feature.
Defined in
profectus/src/features/challenges/challenge.tsx:61
completionLimit
• Optional completionLimit: Computable<DecimalSource>
The maximum number of times the challenge can be completed.
Defined in
profectus/src/features/challenges/challenge.tsx:57
display
• Optional display: Computable<CoercableComponent | { description: CoercableComponent ; effectDisplay?: CoercableComponent ; goal?: CoercableComponent ; reward?: CoercableComponent ; title?: CoercableComponent }>
The display to use for this challenge.
Defined in
profectus/src/features/challenges/challenge.tsx:65
mark
• Optional mark: Computable<string | boolean>
Shows a marker on the corner of the feature.
Defined in
profectus/src/features/challenges/challenge.tsx:59
maximize
• Optional maximize: Computable<boolean>
Whether or not completing this challenge should grant multiple completions if requirements met. Requires requirements to be a requirement or array of requirements with Requirement.canMaximize true.
Defined in
profectus/src/features/challenges/challenge.tsx:55
onComplete
• Optional onComplete: VoidFunction
A function that is called when the challenge is completed.
Defined in
profectus/src/features/challenges/challenge.tsx:81
onEnter
• Optional onEnter: VoidFunction
A function that is called when the challenge is entered.
Defined in
profectus/src/features/challenges/challenge.tsx:85
onExit
• Optional onExit: VoidFunction
A function that is called when the challenge is exited.
Defined in
profectus/src/features/challenges/challenge.tsx:83
requirements
• requirements: Requirements
The requirement(s) to complete this challenge.
Defined in
profectus/src/features/challenges/challenge.tsx:53
reset
• Optional reset: GenericReset
The reset function for this challenge.
Defined in
profectus/src/features/challenges/challenge.tsx:51
style
• Optional style: Computable<StyleValue>
CSS to apply to this feature.
Defined in
profectus/src/features/challenges/challenge.tsx:63
visibility
• Optional visibility: Computable<boolean | Visibility>
Whether this challenge should be visible.