Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Dev] Improve typing in phaseInterceptor.ts #4560

Merged
merged 8 commits into from
Oct 10, 2024
Merged

[Dev] Improve typing in phaseInterceptor.ts #4560

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0ec4918
improve typing in phaseInterceptor
torranx Oct 3, 2024
0a649b0
add more param typings
torranx Oct 3, 2024
42335b4
Merge branch 'beta' into dev/phaseInterceptor-cleanup
flx-sta Oct 3, 2024
4de85a8
Merge branch 'beta' into dev/phaseInterceptor-cleanup
torranx Oct 4, 2024
6bc72ee
Merge branch 'beta' into dev/phaseInterceptor-cleanup
DayKev Oct 4, 2024
f4197c7
Merge branch 'beta' into dev/phaseInterceptor-cleanup
torranx Oct 4, 2024
4697fe6
Merge branch 'beta' into dev/phaseInterceptor-cleanup
torranx Oct 6, 2024
bf1c5a8
Merge branch 'beta' into dev/phaseInterceptor-cleanup
DayKev Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 117 additions & 7 deletions src/test/utils/phaseInterceptor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import {
} from "#app/phases/mystery-encounter-phases";
import { ModifierRewardPhase } from "#app/phases/modifier-reward-phase";
import { PartyExpPhase } from "#app/phases/party-exp-phase";
import { ExpPhase } from "#app/phases/exp-phase";

export interface PromptHandler {
phaseTarget?: string;
Expand All @@ -61,7 +62,114 @@ export interface PromptHandler {
expireFn?: () => void;
awaitingActionInput?: boolean;
}
import { ExpPhase } from "#app/phases/exp-phase";

type PhaseClass =
| typeof LoginPhase
| typeof TitlePhase
| typeof SelectGenderPhase
| typeof EncounterPhase
| typeof NewBiomeEncounterPhase
| typeof SelectStarterPhase
| typeof PostSummonPhase
| typeof SummonPhase
| typeof ToggleDoublePositionPhase
| typeof CheckSwitchPhase
| typeof ShowAbilityPhase
| typeof MessagePhase
| typeof TurnInitPhase
| typeof CommandPhase
| typeof EnemyCommandPhase
| typeof TurnStartPhase
| typeof MovePhase
| typeof MoveEffectPhase
| typeof DamagePhase
| typeof FaintPhase
| typeof BerryPhase
| typeof TurnEndPhase
| typeof BattleEndPhase
| typeof EggLapsePhase
| typeof SelectModifierPhase
| typeof NextEncounterPhase
| typeof NewBattlePhase
| typeof VictoryPhase
| typeof LearnMovePhase
| typeof MoveEndPhase
| typeof StatStageChangePhase
| typeof ShinySparklePhase
| typeof SelectTargetPhase
| typeof UnavailablePhase
| typeof QuietFormChangePhase
| typeof SwitchPhase
| typeof SwitchSummonPhase
| typeof PartyHealPhase
| typeof EvolutionPhase
| typeof EndEvolutionPhase
| typeof LevelCapPhase
| typeof AttemptRunPhase
| typeof SelectBiomePhase
| typeof MysteryEncounterPhase
| typeof MysteryEncounterOptionSelectedPhase
| typeof MysteryEncounterBattlePhase
| typeof MysteryEncounterRewardsPhase
| typeof PostMysteryEncounterPhase
| typeof ModifierRewardPhase
| typeof PartyExpPhase
| typeof ExpPhase;

type PhaseString =
| "LoginPhase"
| "TitlePhase"
| "SelectGenderPhase"
| "EncounterPhase"
| "NewBiomeEncounterPhase"
| "SelectStarterPhase"
| "PostSummonPhase"
| "SummonPhase"
| "ToggleDoublePositionPhase"
| "CheckSwitchPhase"
| "ShowAbilityPhase"
| "MessagePhase"
| "TurnInitPhase"
| "CommandPhase"
| "EnemyCommandPhase"
| "TurnStartPhase"
| "MovePhase"
| "MoveEffectPhase"
| "DamagePhase"
| "FaintPhase"
| "BerryPhase"
| "TurnEndPhase"
| "BattleEndPhase"
| "EggLapsePhase"
| "SelectModifierPhase"
| "NextEncounterPhase"
| "NewBattlePhase"
| "VictoryPhase"
| "LearnMovePhase"
| "MoveEndPhase"
| "StatStageChangePhase"
| "ShinySparklePhase"
| "SelectTargetPhase"
| "UnavailablePhase"
| "QuietFormChangePhase"
| "SwitchPhase"
| "SwitchSummonPhase"
| "PartyHealPhase"
| "EvolutionPhase"
| "EndEvolutionPhase"
| "LevelCapPhase"
| "AttemptRunPhase"
| "SelectBiomePhase"
| "MysteryEncounterPhase"
| "MysteryEncounterOptionSelectedPhase"
| "MysteryEncounterBattlePhase"
| "MysteryEncounterRewardsPhase"
| "PostMysteryEncounterPhase"
| "ModifierRewardPhase"
| "PartyExpPhase"
| "ExpPhase";

type PhaseInterceptorPhase = PhaseClass | PhaseString;

export default class PhaseInterceptor {
public scene;
Expand Down Expand Up @@ -172,17 +280,18 @@ export default class PhaseInterceptor {
* @param phaseFrom - The phase to start from.
* @returns The instance of the PhaseInterceptor.
*/
runFrom(phaseFrom) {
runFrom(phaseFrom: PhaseInterceptorPhase): PhaseInterceptor {
this.phaseFrom = phaseFrom;
return this;
}

/**
* Method to transition to a target phase.
* @param phaseTo - The phase to transition to.
* @param runTarget - Whether or not to run the target phase.
* @returns A promise that resolves when the transition is complete.
*/
async to(phaseTo, runTarget: boolean = true): Promise<void> {
async to(phaseTo: PhaseInterceptorPhase, runTarget: boolean = true): Promise<void> {
return new Promise(async (resolve, reject) => {
ErrorInterceptor.getInstance().add(this);
if (this.phaseFrom) {
Expand Down Expand Up @@ -219,7 +328,7 @@ export default class PhaseInterceptor {
* @param skipFn - Optional skip function.
* @returns A promise that resolves when the phase is run.
*/
run(phaseTarget, skipFn?): Promise<void> {
run(phaseTarget: PhaseInterceptorPhase, skipFn?): Promise<void> {
torranx marked this conversation as resolved.
Show resolved Hide resolved
const targetName = typeof phaseTarget === "string" ? phaseTarget : phaseTarget.name;
this.scene.moveAnimations = null; // Mandatory to avoid crash
return new Promise(async (resolve, reject) => {
Expand Down Expand Up @@ -253,7 +362,7 @@ export default class PhaseInterceptor {
});
}

whenAboutToRun(phaseTarget, skipFn?): Promise<void> {
whenAboutToRun(phaseTarget: PhaseInterceptorPhase, skipFn?): Promise<void> {
torranx marked this conversation as resolved.
Show resolved Hide resolved
const targetName = typeof phaseTarget === "string" ? phaseTarget : phaseTarget.name;
this.scene.moveAnimations = null; // Mandatory to avoid crash
return new Promise(async (resolve, reject) => {
Expand Down Expand Up @@ -311,7 +420,7 @@ export default class PhaseInterceptor {
* Method to start a phase and log it.
* @param phase - The phase to start.
*/
startPhase(phase) {
startPhase(phase: PhaseClass) {
this.log.push(phase.name);
const instance = this.scene.getCurrentPhase();
this.onHold.push({
Expand Down Expand Up @@ -340,7 +449,8 @@ export default class PhaseInterceptor {

/**
* m2m to set mode.
* @param phase - The phase to start.
* @param mode - The {@linkcode Mode} to set.
* @param args - Additional arguments to pass to the original method.
*/
setMode(mode: Mode, ...args: any[]): Promise<void> {
torranx marked this conversation as resolved.
Show resolved Hide resolved
const currentPhase = this.scene.getCurrentPhase();
Expand Down
Loading