Allow beatmap to be optional when converting a replay

kionell · Jun 18, 2023 · b65d668 · b65d668
1 parent 28838c7
commit b65d668
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 11 deletions.
diff --git a/src/Replays/ReplayConverter.ts b/src/Replays/ReplayConverter.ts
@@ -15,7 +15,7 @@ export abstract class ReplayConverter {
    * @param original Any kind of a replay.
    * @returns The converted replay.
    */
-  convertReplay(original: IReplay, beatmap: IBeatmap): Replay {
+  convertReplay(original: IReplay, beatmap?: IBeatmap): Replay {
     const converted = this.createReplay();
 
     converted.gameVersion = original.gameVersion;
@@ -34,11 +34,11 @@ export abstract class ReplayConverter {
     return new Replay();
   }
 
-  *convertFrames(frames: IReplayFrame[], beatmap: IBeatmap): Generator<ReplayFrame> {
+  *convertFrames(frames: IReplayFrame[], beatmap?: IBeatmap): Generator<ReplayFrame> {
     let lastFrame: ReplayFrame | null = null;
 
     for (const frame of frames) {
-      const convertedFrame = this._convertFrame(frame, beatmap, lastFrame);
+      const convertedFrame = this._convertFrame(frame, lastFrame, beatmap);
 
       yield convertedFrame;
 
@@ -48,8 +48,8 @@ export abstract class ReplayConverter {
 
   protected _convertFrame(
     frame: IReplayFrame,
-    beatmap: IBeatmap,
     lastFrame: IReplayFrame | null,
+    beatmap?: IBeatmap,
   ): ReplayFrame {
     if (this._isConvertedReplayFrame(frame)) {
       return frame;
@@ -58,12 +58,15 @@ export abstract class ReplayConverter {
     const convertedFrame = this._createConvertibleReplayFrame();
 
     if (convertedFrame && frame instanceof LegacyReplayFrame) {
-      return convertedFrame.fromLegacy(frame, beatmap, lastFrame);
+      return convertedFrame.fromLegacy(frame, lastFrame, beatmap);
     }
 
     throw new Error('Replay can not be converted to this ruleset!');
   }
 
+  /**
+   * @returns A new instance of convertible replay frame.
+   */
   protected abstract _createConvertibleReplayFrame(): IConvertibleReplayFrame | null;
 
   /**

diff --git a/src/Replays/Types/IConvertibleReplayFrame.ts b/src/Replays/Types/IConvertibleReplayFrame.ts
@@ -16,14 +16,14 @@ export interface IConvertibleReplayFrame extends IReplayFrame {
    */
   fromLegacy(
     currentFrame: LegacyReplayFrame,
-    beatmap: IBeatmap,
-    lastFrame: IReplayFrame | null
+    lastFrame: IReplayFrame | null,
+    beatmap?: IBeatmap,
   ): this;
 
   /**
    * Populates this {@link ReplayFrame} using values from a {@link LegacyReplayFrame}.
    * @param beatmap The beatmap of the replay which is used to get some data.
    * @returns A new instance of legacy replay frame.
    */
-  toLegacy(beatmap: IBeatmap): LegacyReplayFrame;
+  toLegacy(beatmap?: IBeatmap): LegacyReplayFrame;
 }
diff --git a/src/Rulesets/IRuleset.ts b/src/Rulesets/IRuleset.ts
@@ -48,7 +48,7 @@ export interface IRuleset {
    * @param beatmap The beatmap of the replay which is used to get some data.
    * @returns A new instance of the replay with applied ruleset.
    */
-  applyToReplay(replay: IReplay, beatmap: IBeatmap): Replay;
+  applyToReplay(replay: IReplay, beatmap?: IBeatmap): Replay;
 
   /**
    * Resets a mod combination from a beatmap.

diff --git a/src/Rulesets/Ruleset.ts b/src/Rulesets/Ruleset.ts
@@ -118,8 +118,8 @@ export abstract class Ruleset implements IRuleset {
    * @param beatmap The beatmap of the replay which is used to get some data.
    * @returns A new instance of the replay with applied ruleset.
    */
-  applyToReplay(replay: IReplay, beatmap: IBeatmap): Replay {
-    if (replay.mode !== beatmap.mode) {
+  applyToReplay(replay: IReplay, beatmap?: IBeatmap): Replay {
+    if (beatmap && replay.mode !== beatmap.mode) {
       throw new Error('Replay and beatmap mode does not match!');
     }