Merge pull request #4187 from ben-lear/mystery-encounters

PR feedback on MEs

src/phases/party-exp-phase.ts

@@ -1,6 +1,10 @@
 import BattleScene from "#app/battle-scene";
 import { Phase } from "#app/phase";
 
+/**
+ * Provides EXP to the player's party *without* doing any Pokemon defeated checks or queueing extraneous post-battle phases
+ * Intended to be used as a more 1-off phase to provide exp to the party (such as during MEs), rather than cleanup a battle entirely
+ */
 export class PartyExpPhase extends Phase {
   expValue: number;
   useWaveIndexMultiplier?: boolean;

src/phases/summon-phase.ts

@@ -93,6 +93,9 @@ export class SummonPhase extends PartyMemberPokemonPhase {
     }
   }
 
+  /**
+   * Enemy trainer or player trainer will do animations to throw Pokeball and summon a Pokemon to the field.
+   */
   summon(): void {
     const pokemon = this.getPokemon();
 
@@ -171,6 +174,11 @@ export class SummonPhase extends PartyMemberPokemonPhase {
     });
   }
 
+  /**
+   * Handles tweening and battle setup for a wild Pokemon that appears outside of the normal screen transition.
+   * Wild Pokemon will ease and fade in onto the field, then perform standard summon behavior.
+   * Currently only used by Mystery Encounters, as all other battle types pre-summon wild pokemon before screen transitions.
+   */
   summonWild(): void {
     const pokemon = this.getPokemon();