Add Subtitles to the Chart Editor!

Author: sector-a

source/funkin/play/PlayState.hx

@@ -2498,7 +2498,7 @@ class PlayState extends MusicBeatSubState
 
     if (Preferences.subtitles)
     {
-      var subtitlesFile = 'songs/${currentSong.id}/subtitles/song-lyrics';
+      var subtitlesFile:String = 'songs/${currentSong.id}/subtitles/song-lyrics';
       if (currentVariation != Constants.DEFAULT_VARIATION)
       {
         subtitlesFile += '-${currentVariation}';

source/funkin/save/Save.hx

@@ -379,6 +379,23 @@ class Save implements ConsoleClass
     return data.optionsChartEditor.showNoteKinds;
   }
 
+  public var chartEditorShowSubtitles(get, set):Bool;
+
+  function get_chartEditorShowSubtitles():Bool
+  {
+    if (data.optionsChartEditor.showSubtitles == null) data.optionsChartEditor.showSubtitles = true;
+
+    return data.optionsChartEditor.showSubtitles;
+  }
+
+  function set_chartEditorShowSubtitles(value:Bool):Bool
+  {
+    // Set and apply.
+    data.optionsChartEditor.showSubtitles = value;
+    flush();
+    return data.optionsChartEditor.showSubtitles;
+  }
+
   public var chartEditorPlaytestStartTime(get, set):Bool;
 
   function get_chartEditorPlaytestStartTime():Bool
@@ -1886,6 +1903,12 @@ typedef SaveDataChartEditorOptions =
    */
   var ?showNoteKinds:Bool;
 
+  /**
+   * Show Subtitles in the Chart Editor.
+   * @default `true`
+   */
+  var ?showSubtitles:Bool;
+
   /**
    * Metronome volume in the Chart Editor.
    * @default `1.0`

source/funkin/ui/debug/charting/ChartEditorState.hx

@@ -45,6 +45,7 @@ import funkin.play.notes.notekind.NoteKindManager;
 import funkin.play.character.BaseCharacter.CharacterType;
 import funkin.data.character.CharacterData.CharacterDataParser;
 import funkin.play.components.HealthIcon;
+import funkin.play.components.Subtitles;
 import funkin.play.notes.NoteSprite;
 import funkin.play.PlayStatePlaylist;
 import funkin.play.song.Song;
@@ -640,6 +641,23 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
    */
   var showNoteKindIndicators:Bool = false;
 
+  /**
+   * Toggles the subtitles.
+   */
+  var showSubtitles(default, set):Bool = false;
+
+  function set_showSubtitles(value:Bool):Bool
+  {
+    showSubtitles = value;
+
+    if (subtitles != null)
+    {
+      subtitles.exists = showSubtitles;
+    }
+
+    return showSubtitles;
+  }
+
   /**
    * The current theme used by the editor.
    * Dictates the appearance of many UI elements.
@@ -1915,6 +1933,11 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
    */
   var menubarItemViewIndicators:MenuCheckBox;
 
+  /**
+   * The `View -> Subtitles` menu item.
+   */
+  var menubarItemViewSubtitles:MenuCheckBox;
+
   /**
    * The `View -> Increase Difficulty` menu item.
    */
@@ -2226,6 +2249,11 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
    */
   var menuBG:Null<FlxSprite> = null;
 
+  /**
+   * The subtitles to display song's lyrics.
+   */
+  var subtitles:Null<Subtitles> = null;
+
   /**
    * The sprite group containing the note graphics.
    * Only displays a subset of the data from `currentSongChartNoteData`,
@@ -2338,6 +2366,8 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
     populateOpenRecentMenu();
     this.applyPlatformShortcutText();
 
+    createSubtitles();
+
     // Setup the onClick listeners for the UI after it's been created.
     setupUIListeners();
     setupContextMenu();
@@ -2435,6 +2465,7 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
     currentLiveInputStyle = save.chartEditorLiveInputStyle;
     isViewDownscroll = save.chartEditorDownscroll;
     showNoteKindIndicators = save.chartEditorShowNoteKinds;
+    showSubtitles = save.chartEditorShowSubtitles;
     playtestStartTime = save.chartEditorPlaytestStartTime;
     currentTheme = save.chartEditorTheme;
     metronomeVolume = save.chartEditorMetronomeVolume;
@@ -2654,6 +2685,14 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
     add(audioWaveforms);
   }
 
+  function createSubtitles():Void
+  {
+    subtitles = new Subtitles(FlxG.height * 0.85);
+    subtitles.zIndex = 100;
+    subtitles.cameras = [uiCamera];
+    add(subtitles);
+  }
+
   function buildMeasureTicks():Void
   {
     measureTicks = new ChartEditorMeasureTicks(this);
@@ -3179,6 +3218,9 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
     menubarItemViewIndicators.onClick = event -> showNoteKindIndicators = menubarItemViewIndicators.selected;
     menubarItemViewIndicators.selected = showNoteKindIndicators;
 
+    menubarItemViewSubtitles.onClick = event -> showSubtitles = menubarItemViewSubtitles.selected;
+    menubarItemViewSubtitles.selected = showSubtitles;
+
     menubarItemDifficultyUp.onClick = _ -> incrementDifficulty(1);
     menubarItemDifficultyDown.onClick = _ -> incrementDifficulty(-1);
 
@@ -6866,6 +6908,16 @@ class ChartEditorState extends UIState // UIState derives from MusicBeatState
     healthIconsDirty = true;
   }
 
+  public function loadSubtitles():Void
+  {
+    var subtitlesFile:String = 'songs/${currentSongId}/subtitles/song-lyrics';
+    if (selectedVariation != Constants.DEFAULT_VARIATION)
+    {
+      subtitlesFile += '-${selectedVariation}';
+    }
+    subtitles.assignSubtitles(subtitlesFile, audioInstTrack);
+  }
+
   public function postLoadVocals():Void
   {
     // Reapply the volume and playback rate.

source/funkin/ui/debug/charting/handlers/ChartEditorAudioHandler.hx

@@ -144,6 +144,8 @@ class ChartEditorAudioHandler
 
     state.hardRefreshFreeplayToolbox();
 
+    state.loadSubtitles();
+
     return true;
   }