Class ChallengeAbstract

constructor

• new Challenge(id, maxValue?): Challenge

• Parameters

  • id: Challenges

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

  Returns Challenge

conditions

id

maxSeverity

maxValue

severity

value

applyFixedBattle

• applyFixedBattle(waveIndex, battleConfig): boolean

• An apply function for FIXED_BATTLE challenges. Derived classes should alter this.

  Parameters

  • waveIndex: Number

    Number The current wave index.
  • battleConfig: FixedBattleConfig

    FixedBattleConfig The battle config to modify.

  Returns boolean

  boolean Whether this function did anything.

applyGameModeModify

• applyGameModeModify(gameMode): boolean

• An apply function for GAME_MODE_MODIFY challenges. Derived classes should alter this.

  Parameters

  • gameMode: GameMode

    GameMode The current game mode.

  Returns boolean

  boolean Whether this function did anything.

applyLevelChange

• applyLevelChange(level, levelCap, isTrainer, isBoss): boolean

• An apply function for AI_LEVEL challenges. Derived classes should alter this.

  Parameters

  • level: IntegerHolder

    Utils.IntegerHolder The generated level.
  • levelCap: number

    Number The current level cap.
  • isTrainer: boolean

    Boolean Whether this is a trainer pokemon.
  • isBoss: boolean

    Boolean Whether this is a non-trainer boss pokemon.

  Returns boolean

  boolean Whether this function did anything.

applyMoveAccessLevel

• applyMoveAccessLevel(pokemon, moveSource, move, level): boolean

• An apply function for MOVE_ACCESS. Derived classes should alter this.

  Parameters

  • pokemon: default

    Pokemon What pokemon would learn the move.
  • moveSource: MoveSourceType

    MoveSourceType What source the pokemon would get the move from.
  • move: Moves

    Moves The move in question.
  • level: IntegerHolder

    Utils.IntegerHolder The level threshold for access.

  Returns boolean

  boolean Whether this function did anything.

applyMoveSlot

• applyMoveSlot(pokemon, moveSlots): boolean

• An apply function for AI_MOVE_SLOTS challenges. Derived classes should alter this.

  Parameters

  • pokemon: default

    Pokemon The pokemon that is being considered.
  • moveSlots: IntegerHolder

    Utils.IntegerHolder The amount of move slots.

  Returns boolean

  boolean Whether this function did anything.

applyMoveWeight

• applyMoveWeight(pokemon, moveSource, move, level): boolean

• An apply function for MOVE_WEIGHT. Derived classes should alter this.

  Parameters

  • pokemon: default

    Pokemon What pokemon would learn the move.
  • moveSource: MoveSourceType

    MoveSourceType What source the pokemon would get the move from.
  • move: Moves

    Moves The move in question.
  • level: IntegerHolder

  Returns boolean

  boolean Whether this function did anything.

applyPassiveAccess

• applyPassiveAccess(pokemon, hasPassive): boolean

• An apply function for PASSIVE_ACCESS challenges. Derived classes should alter this.

  Parameters

  • pokemon: default

    Pokemon The pokemon to change.
  • hasPassive: BooleanHolder

    Utils.BooleanHolder Whether it should have its passive.

  Returns boolean

  boolean Whether this function did anything.

applyPokemonInBattle

• applyPokemonInBattle(pokemon, valid): boolean

• An apply function for POKEMON_IN_BATTLE challenges. Derived classes should alter this.

  Parameters

  • pokemon: default

    Pokemon The pokemon to check the validity of.
  • valid: BooleanHolder

    Utils.BooleanHolder A BooleanHolder, the value gets set to false if the pokemon isn't allowed.

  Returns boolean

  boolean Whether this function did anything.

applyStarterChoice

• applyStarterChoice(pokemon, valid, dexAttr, soft?, checkEvolutions?, checkForms?): boolean

• An apply function for STARTER_CHOICE challenges. Derived classes should alter this.

  Parameters

  • pokemon: default

    PokemonSpecies The pokemon to check the validity of.
  • valid: BooleanHolder

    Utils.BooleanHolder A BooleanHolder, the value gets set to false if the pokemon isn't allowed.
  • dexAttr: DexAttrProps

    DexAttrProps The dex attributes of the pokemon.
  • soft: boolean = false

    boolean If true, allow it if it could become a valid pokemon.
  • OptionalcheckEvolutions: boolean

    boolean If true, check the pokemon's future evolutions
  • OptionalcheckForms: boolean

    boolean If true, check the pokemon's alternative forms

  Returns boolean

  boolean Whether this function did anything.

applyStarterCost

• applyStarterCost(species, cost): boolean

• An apply function for STARTER_COST challenges. Derived classes should alter this.

  Parameters

  • species: Species

    Species The pokemon to change the cost of.
  • cost: NumberHolder

    Utils.NumberHolder The cost of the starter.

  Returns boolean

  boolean Whether this function did anything.

applyStarterModify

• applyStarterModify(pokemon): boolean

• An apply function for STARTER_MODIFY challenges. Derived classes should alter this.

  Parameters

  • pokemon: default

    Pokemon The starter pokemon to modify.

  Returns boolean

  boolean Whether this function did anything.

applyStarterPoints

• applyStarterPoints(points): boolean

• An apply function for STARTER_POINTS challenges. Derived classes should alter this.

  Parameters

  • points: NumberHolder

    Utils.NumberHolder The amount of points you have available.

  Returns boolean

  boolean Whether this function did anything.

condition

• condition(condition): Challenge

• Adds an unlock condition to this challenge.

  Parameters

  • condition: ChallengeCondition

    ChallengeCondition The condition to add.

  Returns Challenge

  Challenge This challenge

decreaseSeverity

• decreaseSeverity(): boolean

• Decrease the severity of the challenge

  Returns boolean

  boolean Returns true if the value changed

decreaseValue

• decreaseValue(): boolean

• Decrease the value of the challenge

  Returns boolean

  boolean Returns true if the value changed

getDescription

• getDescription(overrideValue?): string

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

  Parameters

  • OptionaloverrideValue: number

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

  Returns string

  string The localised description for the current value.

getDifficulty

• getDifficulty(): number

• Gets the "difficulty" value of this challenge.

  Returns number

  integer The difficulty value.

getMinDifficulty

• getMinDifficulty(): number

• Gets the minimum difficulty added by this challenge.

  Returns number

  integer The difficulty value.

getName

• getName(): string

• Returns string

  string The localised name of this challenge.

getValue

• getValue(overrideValue?): string

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

  Parameters

  • OptionaloverrideValue: number

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

  Returns string

  string The localised name for the current value.

geti18nKey

• geti18nKey(): string

• Gets the localisation key for the challenge

  Returns string

  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

  boolean Returns true if the value changed

increaseValue

• increaseValue(): boolean

• Increase the value of the challenge

  Returns boolean

  boolean Returns true if the value changed

isUnlocked

• isUnlocked(data): boolean

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

  Parameters

  • data: GameData

    GameData The save data.

  Returns boolean

  boolean Whether this challenge is unlocked.

reset

• reset(): void

• Reset the challenge to a base state.

  Returns void

StaticloadChallenge

• loadChallenge(source): Challenge

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

  Parameters

  • source: any

    The source challenge or json.

  Returns Challenge

  This challenge.