Class MysteryEncounterOptionBuilder

constructor

• new MysteryEncounterOptionBuilder(): MysteryEncounterOptionBuilder

  Returns MysteryEncounterOptionBuilder

Optionaldialogue

excludePrimaryFromSecondaryRequirements

hasDexProgress

isDisabledOnRequirementsNotMet

optionMode

primaryPokemonRequirements

requirements

secondaryPokemonRequirements

build

• build(this: IMysteryEncounterOption): default

  Parameters

  • this: IMysteryEncounterOption

  Returns default

withDialogue

• withDialogue(dialogue: OptionTextDisplay): MysteryEncounterOptionBuilder

  Set the full dialogue object to the option. Will override anything already set

  Parameters

  • dialogue: OptionTextDisplay

    see OptionTextDisplay

  Returns MysteryEncounterOptionBuilder

withHasDexProgress

• withHasDexProgress(
      hasDexProgress: boolean,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "hasDexProgress">,
  >

  Parameters

  • hasDexProgress: boolean

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "hasDexProgress">,
  >

withOptionPhase

• withOptionPhase(
      onOptionPhase: OptionPhaseCallback,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "onOptionPhase">,
  >

  MUST be defined by every MysteryEncounterOption

  Parameters

  • onOptionPhase: OptionPhaseCallback

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "onOptionPhase">,
  >

withPokemonCanLearnMoveRequirement

• withPokemonCanLearnMoveRequirement(
      move: Moves | Moves[],
      options?: CanLearnMoveRequirementOptions,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "primaryPokemonRequirements">,
  >

  Player is required to have a pokemon that can learn a certain move/moveset

  Parameters

  • move: Moves | Moves[]

    the required move/moves
  • Optionaloptions: CanLearnMoveRequirementOptions

    see CanLearnMoveRequirementOptions

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "primaryPokemonRequirements">,
  >

withPokemonTypeRequirement

• withPokemonTypeRequirement(
      type: PokemonType | PokemonType[],
      excludeFainted?: boolean,
      minNumberOfPokemon?: number,
      invertQuery?: boolean,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "primaryPokemonRequirements">,
  >

  Player is required to have certain type/s of pokemon in his party (with optional min number of pokemons with that type)

  Parameters

  • type: PokemonType | PokemonType[]

    the required type/s
  • OptionalexcludeFainted: boolean

    whether to exclude fainted pokemon
  • OptionalminNumberOfPokemon: number

    number of pokemons to have that type
  • OptionalinvertQuery: boolean

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "primaryPokemonRequirements">,
  >

withPostOptionPhase

• withPostOptionPhase(
      onPostOptionPhase: OptionPhaseCallback,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "onPostOptionPhase">,
  >

  Parameters

  • onPostOptionPhase: OptionPhaseCallback

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "onPostOptionPhase">,
  >

withPreOptionPhase

• withPreOptionPhase(
      onPreOptionPhase: OptionPhaseCallback,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "onPreOptionPhase">,
  >

  Defines logic that runs immediately when an option is selected, but before the Encounter continues. Can determine whether or not the Encounter should continue. If there are scenarios where the Encounter should NOT continue, should return boolean instead of void.

  Parameters

  • onPreOptionPhase: OptionPhaseCallback

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "onPreOptionPhase">,
  >

withPrimaryPokemonRequirement

• withPrimaryPokemonRequirement(
      requirement: EncounterPokemonRequirement,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "primaryPokemonRequirements">,
  >

  Adds a EncounterPokemonRequirement to primaryPokemonRequirements

  Parameters

  • requirement: EncounterPokemonRequirement

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "primaryPokemonRequirements">,
  >

withSceneMoneyRequirement

• withSceneMoneyRequirement(
      requiredMoney: number,
      scalingMultiplier?: number,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "requirements">,
  >

  Parameters

  • requiredMoney: number
  • OptionalscalingMultiplier: number

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "requirements">,
  >

withSceneRequirement

• withSceneRequirement(
      requirement: EncounterSceneRequirement,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "requirements">,
  >

  Adds a EncounterSceneRequirement to requirements

  Parameters

  • requirement: EncounterSceneRequirement

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "requirements">,
  >

withSecondaryPokemonRequirement

• withSecondaryPokemonRequirement(
      requirement: EncounterPokemonRequirement,
      excludePrimaryFromSecondaryRequirements?: boolean,
  ): MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "secondaryPokemonRequirements">,
  >

  Adds a EncounterPokemonRequirement to secondaryPokemonRequirements

  Parameters

  • requirement: EncounterPokemonRequirement
  • excludePrimaryFromSecondaryRequirements: boolean = true

  Returns MysteryEncounterOptionBuilder & Required<
      Pick<IMysteryEncounterOption, "secondaryPokemonRequirements">,
  >

StaticnewOptionWithMode

• newOptionWithMode(
      optionMode: MysteryEncounterOptionMode,
  ): MysteryEncounterOptionBuilder & Pick<
      IMysteryEncounterOption,
      "optionMode",
  >

  Parameters

  • optionMode: MysteryEncounterOptionMode

  Returns MysteryEncounterOptionBuilder & Pick<IMysteryEncounterOption, "optionMode">