Class ChallengeAbstract

constructor

• new Challenge(id, maxValue?): Challenge

• Parameters

  • id: Challenges

    The enum value for the challenge
  • maxValue: number = Number.MAX_SAFE_INTEGER

  Returns Challenge

challengeTypes

conditions

id

maxSeverity

maxValue

severity

value

addChallengeType

• addChallengeType(challengeType): Challenge

• Adds a challenge type to this challenge.

  Parameters

  • challengeType: ChallengeType

    The challenge type to add.

  Returns Challenge

  This challenge

Abstract apply

• apply(challengeType, args): boolean

• Modifies the data or game state in some way to apply the challenge.

  Parameters

  • challengeType: ChallengeType

    Which challenge type this is being applied for.
  • args: any[]

    Irrelevant. See the specific challenge's apply function for additional information.

  Returns boolean

condition

• condition(condition): Challenge

• Adds an unlock condition to this challenge.

  Parameters

  • condition: ChallengeCondition

    The condition to add.

  Returns Challenge

  This challenge

decreaseSeverity

• decreaseSeverity(): boolean

• Decrease the severity of the challenge

  Returns boolean

  Returns true if the value changed

decreaseValue

• decreaseValue(): boolean

• Decrease the value of the challenge

  Returns boolean

  Returns true if the value changed

getDescription

• getDescription(overrideValue?): string

• Returns the description of a challenge's current value.

  Parameters

  • Optional overrideValue: number

    The value to check for. If undefined, gets the current value.

  Returns string

  The localised description for the current value.

getDifficulty

• getDifficulty(): number

• Gets the "difficulty" value of this challenge.

  Returns number

  The difficulty value.

getMinDifficulty

• getMinDifficulty(): number

• Gets the minimum difficulty added by this challenge.

  Returns number

  The difficulty value.

getName

• getName(): string

• Returns string

  The localised name of this challenge.

getValue

• getValue(overrideValue?): string

• Returns the textual representation of a challenge's current value.

  Parameters

  • Optional overrideValue: number

    The value to check for. If undefined, gets the current value.

  Returns string

  The localised name for the current value.

geti18nKey

• geti18nKey(): string

• Gets the localisation key for the challenge

  Returns string

  The i18n key for this challenge

hasSeverity

• hasSeverity(): boolean

• Whether to allow choosing this challenge's severity.

  Returns boolean

increaseSeverity

• increaseSeverity(): boolean

• Increase the severity of the challenge

  Returns boolean

  Returns true if the value changed

increaseValue

• increaseValue(): boolean

• Increase the value of the challenge

  Returns boolean

  Returns true if the value changed

isOfType

• isOfType(challengeType): boolean

• If this challenge is of a particular type

  Parameters

  • challengeType: ChallengeType

    The challenge type to check.

  Returns boolean

  This challenge

isUnlocked

• isUnlocked(data): boolean

• Used for unlockable challenges to check if they're unlocked.

  Parameters

  • data: GameData

    The save data.

  Returns boolean

  Whether this challenge is unlocked.

reset

• reset(): void

• Reset the challenge to a base state.

  Returns void

Static loadChallenge

• loadChallenge(source): Challenge

• Clones a challenge, either from another challenge or json. Chainable.

  Parameters

  • source: any

    The source challenge of json.

  Returns Challenge

  This challenge.