Story Mode Handling

Author: TechnikTil

src/funkin/Constants.hx

@@ -54,6 +54,11 @@ class Constants
 	 */
 	public static final DEFAULT_DIFFICULTIES:Array<String> = ['easy', 'normal', 'hard', 'erect', 'nightmare'];
 
+	/**
+	 * Default Difficulty
+	 */
+	public static final DEFAULT_DIFFICULTY:String = 'normal';
+
 	static function get_TECHNOTDRIP_VERSION():String
 	{
 		return FlxG.stage.application.meta.get('version');

src/funkin/states/gameplay/PlayState.hx

@@ -1,9 +1,11 @@
 package funkin.states.gameplay;
 
+import flixel.util.FlxSort;
 import funkin.data.StrumlineData;
 import funkin.data.song.Song;
 import funkin.objects.gameplay.strumline.Strumline;
 import funkin.structures.SongStructure;
+import funkin.util.StoryModeHandler;
 
 class PlayState extends FunkinState
 {
@@ -13,6 +15,11 @@ class PlayState extends FunkinState
 	 */
 	public static var instance:PlayState;
 
+	/**
+	 * Story Mode Handler.
+	 */
+	public static var storyMode:StoryModeHandler;
+
 	/**
 	 * The parameters used when initializing this state.
 	 */
@@ -152,6 +159,13 @@ class PlayState extends FunkinState
 		getPlayerSound()?.play();
 		getOpponentSound()?.play();
 
+		var soundsAvailable:Array<FlxSound> = [FlxG.sound.music, getPlayerSound(), getOpponentSound()];
+		soundsAvailable.sort((a:FlxSound, b:FlxSound) ->
+		{
+			return FlxSort.byValues(FlxSort.DESCENDING, a?.length ?? 0, b?.length ?? 0);
+		});
+		soundsAvailable[0].onComplete = finishSong;
+
 		conductor.setupBPMChanges(metadata.bpmChanges);
 	}
 
@@ -165,10 +179,27 @@ class PlayState extends FunkinState
 		super.update(elapsed);
 
 		if (controls.justPressed.BACK)
+		{
+			finishSong();
+		}
+	}
+
+	/**
+	 * Finish the song.
+	 */
+	public function finishSong():Void
+	{
+		if (storyMode != null)
+		{
+			FlxG.switchState(storyMode.nextState);
+		}
+		else
 		{
 			conductor.changeBPM(102);
+			FlxG.sound.music.onComplete = null;
 			FlxG.sound.playMusic(Paths.content.audio('ui/menu/freakyMenu'));
-			FlxG.switchState(funkin.states.ui.MenuState.new);
+
+			FlxG.switchState(funkin.states.ui.FreeplayState.new);
 		}
 	}
 

src/funkin/states/ui/StoryModeState.hx

@@ -1,6 +1,8 @@
 package funkin.states.ui;
 
 import funkin.objects.ui.WeekItem;
+import funkin.states.gameplay.PlayState;
+import funkin.util.StoryModeHandler;
 import funkin.util.Week;
 
 class StoryModeState extends FunkinState
@@ -40,6 +42,8 @@ class StoryModeState extends FunkinState
 		DiscordRPC.details = 'Story Mode Menu';
 		#end
 
+		PlayState.storyMode = null;
+
 		grpWeekItems = new FlxTypedGroup<WeekItem>();
 		add(grpWeekItems);
 
@@ -142,10 +146,11 @@ class StoryModeState extends FunkinState
 
 			grpWeekItems.members[curSelected].startFlashing();
 
+			PlayState.storyMode = new StoryModeHandler(loadedWeeks[curSelected], _difficulties[curDifficulty]);
+
 			new FlxTimer().start(1, (tmr:FlxTimer) ->
 			{
-				// TODO: Change this to PlayState
-				FlxG.switchState(MenuState.new);
+				FlxG.switchState(PlayState.storyMode.nextState);
 			});
 		}
 

src/funkin/util/StoryModeHandler.hx

@@ -0,0 +1,89 @@
+package funkin.util;
+
+import flixel.FlxState;
+import funkin.data.song.Song;
+import funkin.states.gameplay.PlayState;
+import funkin.states.ui.StoryModeState;
+
+/**
+ * Story Mode Handler for `PlayState`.
+ */
+class StoryModeHandler
+{
+	/**
+	 * The current week for this Story Mode session.
+	 */
+	public var week:Week;
+
+	/**
+	 * The song queue for this Story Mode session.
+	 * Based off of `week.songs`.
+	 */
+	public var songQueue:Array<Song> = [];
+
+	/**
+	 * The current difficulty for this Story Mode session.
+	 * If the current difficulty doesn't exist or is `null`, `Constants.DEFAULT_DIFFICULTY` is used.
+	 * If `Constants.DEFAULT_DIFFICULTY` isn't available, songs will be skipped until a song with this difficulty is available.
+	 */
+	public var difficulty:Null<String> = null;
+
+	/**
+	 * Creates a Story Mode Handler.
+	 * @param week The week to use for this Story Mode session.
+	 * @param difficulty The difficulty to use for this Story Mode Session. See `difficulty` for more information.
+	 */
+	public function new(week:Week, ?difficulty:Null<String> = null)
+	{
+		this.week = week;
+		this.difficulty = difficulty;
+		songQueue = week.songs;
+	}
+
+	/**
+	 * Generates a `PlayState` based on the next song in queue.
+	 * To be used as the parameter for `FlxG.switchState`
+	 * @return `FlxState`
+	 */
+	public function nextState():FlxState
+	{
+		var foundSong:Song = null;
+		var difficultyToUse:String = difficulty;
+
+		while (foundSong == null)
+		{
+			foundSong = songQueue.shift();
+			if (foundSong == null)
+				break;
+
+			var difficulties:Array<String> = foundSong.getDifficulties();
+
+			if (difficulties.contains(difficulty))
+			{
+				difficultyToUse = difficulty;
+				break;
+			}
+
+			if (difficulties.contains(Constants.DEFAULT_DIFFICULTY))
+			{
+				difficultyToUse = Constants.DEFAULT_DIFFICULTY;
+				break;
+			}
+
+			foundSong = null;
+		}
+
+		if (foundSong == null)
+		{
+			FlxG.sound.music.onComplete = null;
+			FlxG.sound.playMusic(Paths.content.audio('ui/menu/freakyMenu'));
+			return new StoryModeState();
+		}
+
+		return new PlayState({
+			variation: 'default',
+			song: foundSong,
+			difficulty: difficultyToUse
+		});
+	}
+}