Funkin/source/funkin/ui/story/StoryMenuState.hx

654 lines
18 KiB
Haxe
Raw Normal View History

package funkin.ui.story;
2023-05-17 16:42:58 -04:00
import flixel.addons.transition.FlxTransitionableState;
import flixel.FlxSprite;
import flixel.group.FlxGroup.FlxTypedGroup;
import flixel.text.FlxText;
import flixel.tweens.FlxEase;
import flixel.tweens.FlxTween;
import flixel.util.FlxColor;
import flixel.util.FlxTimer;
2024-03-11 23:42:32 -04:00
import funkin.audio.FunkinSound;
import funkin.data.level.LevelRegistry;
import funkin.data.song.SongRegistry;
import funkin.graphics.FunkinSprite;
2023-05-17 16:42:58 -04:00
import funkin.modding.events.ScriptEvent;
import funkin.modding.events.ScriptEventDispatcher;
import funkin.play.PlayStatePlaylist;
import funkin.play.song.Song;
import funkin.save.Save;
import funkin.save.Save.SaveScoreData;
import funkin.ui.mainmenu.MainMenuState;
import funkin.ui.MusicBeatState;
import funkin.ui.transition.LoadingState;
import funkin.ui.transition.StickerSubState;
import funkin.util.MathUtil;
import openfl.utils.Assets;
2023-05-17 16:42:58 -04:00
class StoryMenuState extends MusicBeatState
{
static final DEFAULT_BACKGROUND_COLOR:FlxColor = FlxColor.fromString('#F9CF51');
static final BACKGROUND_HEIGHT:Int = 400;
var currentDifficultyId:String = 'normal';
var currentLevelId:String = 'tutorial';
var currentLevel:Level;
var isLevelUnlocked:Bool;
2023-05-17 16:42:58 -04:00
var currentLevelTitle:LevelTitle;
var highScore:Int = 42069420;
var highScoreLerp:Int = 12345678;
var exitingMenu:Bool = false;
2023-05-17 16:42:58 -04:00
var selectedLevel:Bool = false;
var displayingModdedLevels:Bool = false;
//
// RENDER OBJECTS
//
/**
* The title of the level at the top.
*/
var levelTitleText:FlxText;
/**
* The score text at the top.
*/
var scoreText:FlxText;
/**
* The mode text at the top-middle.
*/
var modeText:FlxText;
/**
* The list of songs on the left.
*/
var tracklistText:FlxText;
/**
2023-05-17 16:42:58 -04:00
* The titles of the levels in the middle.
*/
var levelTitles:FlxTypedGroup<LevelTitle>;
/**
* The props in the center.
*/
var levelProps:FlxTypedGroup<LevelProp>;
/**
* The background behind the props.
*/
var levelBackground:FlxSprite;
/**
* The left arrow of the difficulty selector.
*/
var leftDifficultyArrow:FlxSprite;
/**
* The right arrow of the difficulty selector.
*/
var rightDifficultyArrow:FlxSprite;
/**
* The text of the difficulty selector.
*/
var difficultySprite:FlxSprite;
2023-05-17 16:42:58 -04:00
var difficultySprites:Map<String, FlxSprite>;
var stickerSubState:StickerSubState;
static var rememberedLevelId:Null<String> = null;
static var rememberedDifficulty:Null<String> = Constants.DEFAULT_DIFFICULTY;
public function new(?stickers:StickerSubState = null)
{
2023-05-17 16:42:58 -04:00
super();
if (stickers != null)
{
stickerSubState = stickers;
}
}
override function create():Void
{
2023-05-17 16:42:58 -04:00
super.create();
difficultySprites = new Map<String, FlxSprite>();
transIn = FlxTransitionableState.defaultTransIn;
transOut = FlxTransitionableState.defaultTransOut;
playMenuMusic();
if (stickerSubState != null)
{
this.persistentUpdate = true;
this.persistentDraw = true;
openSubState(stickerSubState);
stickerSubState.degenStickers();
}
persistentUpdate = persistentDraw = true;
rememberSelection();
updateData();
// Explicitly define the background color.
this.bgColor = FlxColor.BLACK;
levelTitles = new FlxTypedGroup<LevelTitle>();
levelTitles.zIndex = 15;
add(levelTitles);
2023-05-17 16:42:58 -04:00
updateBackground();
var black:FunkinSprite = new FunkinSprite(levelBackground.x, 0).makeSolidColor(FlxG.width, Std.int(400 + levelBackground.y), FlxColor.BLACK);
2023-06-27 15:21:09 -04:00
black.zIndex = levelBackground.zIndex - 1;
add(black);
levelProps = new FlxTypedGroup<LevelProp>();
2023-05-17 16:42:58 -04:00
levelProps.zIndex = 1000;
add(levelProps);
2023-05-17 16:42:58 -04:00
updateProps();
tracklistText = new FlxText(FlxG.width * 0.05, levelBackground.x + levelBackground.height + 100, 0, "Tracks", 32);
tracklistText.setFormat('VCR OSD Mono', 32);
tracklistText.alignment = CENTER;
tracklistText.color = 0xFFE55777;
add(tracklistText);
scoreText = new FlxText(10, 10, 0, 'HIGH SCORE: 42069420');
scoreText.setFormat('VCR OSD Mono', 32);
scoreText.zIndex = 1000;
add(scoreText);
modeText = new FlxText(10, 10, 0, 'Base Game Levels [TAB to switch]');
modeText.setFormat('VCR OSD Mono', 32);
modeText.screenCenter(X);
modeText.visible = hasModdedLevels();
modeText.zIndex = 1000;
add(modeText);
2023-05-17 16:42:58 -04:00
levelTitleText = new FlxText(FlxG.width * 0.7, 10, 0, 'LEVEL 1');
levelTitleText.setFormat('VCR OSD Mono', 32, FlxColor.WHITE, RIGHT);
levelTitleText.alpha = 0.7;
levelTitleText.zIndex = 1000;
add(levelTitleText);
2023-05-17 16:42:58 -04:00
buildLevelTitles();
2023-05-17 16:42:58 -04:00
leftDifficultyArrow = new FlxSprite(levelTitles.members[0].x + levelTitles.members[0].width + 10, levelTitles.members[0].y + 10);
leftDifficultyArrow.frames = Paths.getSparrowAtlas('storymenu/ui/arrows');
leftDifficultyArrow.animation.addByPrefix('idle', 'leftIdle0');
leftDifficultyArrow.animation.addByPrefix('press', 'leftConfirm0');
leftDifficultyArrow.animation.play('idle');
add(leftDifficultyArrow);
buildDifficultySprite(Constants.DEFAULT_DIFFICULTY);
2023-05-17 16:42:58 -04:00
buildDifficultySprite();
rightDifficultyArrow = new FlxSprite(difficultySprite.x + difficultySprite.width + 10, leftDifficultyArrow.y);
rightDifficultyArrow.frames = leftDifficultyArrow.frames;
rightDifficultyArrow.animation.addByPrefix('idle', 'rightIdle0');
rightDifficultyArrow.animation.addByPrefix('press', 'rightConfirm0');
rightDifficultyArrow.animation.play('idle');
add(rightDifficultyArrow);
add(difficultySprite);
2023-05-17 16:42:58 -04:00
updateText();
changeDifficulty();
changeLevel();
refresh();
#if discord_rpc
// Updating Discord Rich Presence
DiscordClient.changePresence('In the Menus', null);
#end
}
function rememberSelection():Void
{
if (rememberedLevelId != null)
{
currentLevelId = rememberedLevelId;
}
if (rememberedDifficulty != null)
{
currentDifficultyId = rememberedDifficulty;
}
}
function playMenuMusic():Void
{
2024-03-23 17:50:48 -04:00
FunkinSound.playMusic('freakyMenu',
{
overrideExisting: true,
restartTrack: false
});
}
2023-05-17 16:42:58 -04:00
function updateData():Void
{
currentLevel = LevelRegistry.instance.fetchEntry(currentLevelId);
isLevelUnlocked = currentLevel == null ? false : currentLevel.isUnlocked();
}
function buildDifficultySprite(?diff:String):Void
{
if (diff == null) diff = currentDifficultyId;
2023-05-17 16:42:58 -04:00
remove(difficultySprite);
difficultySprite = difficultySprites.get(diff);
2023-05-17 16:42:58 -04:00
if (difficultySprite == null)
{
difficultySprite = new FlxSprite(leftDifficultyArrow.x + leftDifficultyArrow.width + 10, leftDifficultyArrow.y);
2023-05-22 20:55:53 -04:00
if (Assets.exists(Paths.file('images/storymenu/difficulties/${diff}.xml')))
2023-05-22 20:55:53 -04:00
{
difficultySprite.frames = Paths.getSparrowAtlas('storymenu/difficulties/${diff}');
2023-05-22 20:55:53 -04:00
difficultySprite.animation.addByPrefix('idle', 'idle0', 24, true);
if (Preferences.flashingLights) difficultySprite.animation.play('idle');
2023-05-22 20:55:53 -04:00
}
else
{
difficultySprite.loadGraphic(Paths.image('storymenu/difficulties/${diff}'));
2023-05-22 20:55:53 -04:00
}
difficultySprites.set(diff, difficultySprite);
2023-05-17 16:42:58 -04:00
difficultySprite.x += (difficultySprites.get(Constants.DEFAULT_DIFFICULTY).width - difficultySprite.width) / 2;
2023-05-17 16:42:58 -04:00
}
difficultySprite.alpha = 0;
2023-05-22 20:55:53 -04:00
2023-05-17 16:42:58 -04:00
difficultySprite.y = leftDifficultyArrow.y - 15;
2023-05-22 20:55:53 -04:00
var targetY:Float = leftDifficultyArrow.y + 10;
targetY -= (difficultySprite.height - difficultySprites.get(Constants.DEFAULT_DIFFICULTY).height) / 2;
2023-05-22 20:55:53 -04:00
FlxTween.tween(difficultySprite, {y: targetY, alpha: 1}, 0.07);
2023-05-17 16:42:58 -04:00
add(difficultySprite);
}
2023-05-17 16:42:58 -04:00
function buildLevelTitles():Void
{
levelTitles.clear();
2023-05-17 16:42:58 -04:00
var levelIds:Array<String> = displayingModdedLevels ? LevelRegistry.instance.listModdedLevelIds() : LevelRegistry.instance.listBaseGameLevelIds();
2023-05-22 20:55:53 -04:00
if (levelIds.length == 0) levelIds = ['tutorial']; // Make sure there's at least one level to display.
2023-05-17 16:42:58 -04:00
for (levelIndex in 0...levelIds.length)
{
var levelId:String = levelIds[levelIndex];
var level:Level = LevelRegistry.instance.fetchEntry(levelId);
2023-05-17 16:42:58 -04:00
if (level == null) continue;
var levelTitleItem:LevelTitle = new LevelTitle(0, Std.int(levelBackground.y + levelBackground.height + 10), level);
levelTitleItem.targetY = ((levelTitleItem.height + 20) * levelIndex);
levelTitleItem.screenCenter(X);
levelTitles.add(levelTitleItem);
}
}
2023-05-17 16:42:58 -04:00
function switchMode(moddedLevels:Bool):Void
{
displayingModdedLevels = moddedLevels;
buildLevelTitles();
changeLevel(999999); // Jump past the end of the list to the beginning.
2023-05-17 16:42:58 -04:00
changeDifficulty(0);
}
override function update(elapsed:Float):Void
{
Conductor.instance.update();
2024-03-20 23:06:32 -04:00
highScoreLerp = Std.int(MathUtil.smoothLerp(highScoreLerp, highScore, elapsed, 0.5));
2023-05-17 16:42:58 -04:00
scoreText.text = 'LEVEL SCORE: ${Math.round(highScoreLerp)}';
modeText.text = displayingModdedLevels ? 'Mods [TAB to switch]' : 'Base Game [TAB to switch]';
modeText.screenCenter(X);
2023-05-17 16:42:58 -04:00
levelTitleText.text = currentLevel.getTitle();
levelTitleText.x = FlxG.width - (levelTitleText.width + 10); // Right align.
handleKeyPresses();
super.update(elapsed);
}
function handleKeyPresses():Void
{
if (!exitingMenu)
{
2023-05-17 16:42:58 -04:00
if (!selectedLevel)
{
if (controls.UI_UP_P)
{
changeLevel(-1);
2023-05-22 20:55:53 -04:00
changeDifficulty(0);
}
if (controls.UI_DOWN_P)
{
changeLevel(1);
2023-05-22 20:55:53 -04:00
changeDifficulty(0);
}
if (controls.UI_RIGHT)
{
2023-05-17 16:42:58 -04:00
rightDifficultyArrow.animation.play('press');
}
else
{
2023-05-17 16:42:58 -04:00
rightDifficultyArrow.animation.play('idle');
}
if (controls.UI_LEFT)
{
2023-05-17 16:42:58 -04:00
leftDifficultyArrow.animation.play('press');
}
else
{
2023-05-17 16:42:58 -04:00
leftDifficultyArrow.animation.play('idle');
}
if (controls.UI_RIGHT_P)
{
changeDifficulty(1);
}
if (controls.UI_LEFT_P)
{
changeDifficulty(-1);
}
2023-05-17 16:42:58 -04:00
if (FlxG.keys.justPressed.TAB && modeText.visible)
2023-05-17 16:42:58 -04:00
{
switchMode(!displayingModdedLevels);
}
}
if (controls.ACCEPT)
{
2023-05-17 16:42:58 -04:00
selectLevel();
}
}
2023-05-17 16:42:58 -04:00
if (controls.BACK && !exitingMenu && !selectedLevel)
{
2024-03-23 17:50:48 -04:00
FunkinSound.playOnce(Paths.sound('cancelMenu'));
exitingMenu = true;
FlxG.switchState(() -> new MainMenuState());
}
}
function hasModdedLevels():Bool
{
return false;
// return LevelRegistry.instance.listModdedLevelIds().length > 0;
}
2023-05-17 16:42:58 -04:00
/**
* Changes the selected level.
* @param change +1 (down), -1 (up)
*/
function changeLevel(change:Int = 0):Void
{
var levelList:Array<String> = displayingModdedLevels ? LevelRegistry.instance.listModdedLevelIds() : LevelRegistry.instance.listBaseGameLevelIds();
if (levelList.length == 0) levelList = ['tutorial'];
var currentIndex:Int = levelList.indexOf(currentLevelId);
currentIndex += change;
// Wrap around
if (currentIndex < 0) currentIndex = levelList.length - 1;
if (currentIndex >= levelList.length) currentIndex = 0;
2023-06-27 15:21:09 -04:00
var previousLevelId:String = currentLevelId;
2023-05-17 16:42:58 -04:00
currentLevelId = levelList[currentIndex];
rememberedLevelId = currentLevelId;
2023-05-17 16:42:58 -04:00
updateData();
for (index in 0...levelTitles.members.length)
{
var item:LevelTitle = levelTitles.members[index];
2024-02-19 21:40:52 -05:00
item.targetY = (index - currentIndex) * 125 + 480;
2023-05-17 16:42:58 -04:00
if (index == currentIndex)
{
currentLevelTitle = item;
item.alpha = 1.0;
}
else
{
2023-06-27 15:21:09 -04:00
item.alpha = 0.6;
2023-05-17 16:42:58 -04:00
}
}
updateText();
2023-06-27 15:21:09 -04:00
updateBackground(previousLevelId);
2023-05-17 16:42:58 -04:00
updateProps();
refresh();
}
/**
* Changes the selected difficulty.
2023-06-08 16:30:45 -04:00
* @param change +1 (right) to increase difficulty, -1 (left) to decrease difficulty
2023-05-17 16:42:58 -04:00
*/
function changeDifficulty(change:Int = 0):Void
{
var difficultyList:Array<String> = currentLevel.getDifficulties();
var currentIndex:Int = difficultyList.indexOf(currentDifficultyId);
currentIndex += change;
// Wrap around
if (currentIndex < 0) currentIndex = difficultyList.length - 1;
if (currentIndex >= difficultyList.length) currentIndex = 0;
2023-05-22 20:55:53 -04:00
var hasChanged:Bool = currentDifficultyId != difficultyList[currentIndex];
2023-05-17 16:42:58 -04:00
currentDifficultyId = difficultyList[currentIndex];
rememberedDifficulty = currentDifficultyId;
2023-05-17 16:42:58 -04:00
2023-05-22 20:55:53 -04:00
if (difficultyList.length <= 1)
{
leftDifficultyArrow.visible = false;
rightDifficultyArrow.visible = false;
}
else
{
leftDifficultyArrow.visible = true;
rightDifficultyArrow.visible = true;
}
if (hasChanged)
{
buildDifficultySprite();
// Disable the funny music thing for now.
// funnyMusicThing();
2023-05-22 20:55:53 -04:00
}
}
final FADE_OUT_TIME:Float = 1.5;
function funnyMusicThing():Void
{
if (currentDifficultyId == "nightmare")
{
FlxG.sound.music.fadeOut(FADE_OUT_TIME, 0.0);
}
else
{
FlxG.sound.music.fadeOut(FADE_OUT_TIME, 1.0);
}
2023-05-17 16:42:58 -04:00
}
2023-06-16 17:37:56 -04:00
public override function dispatchEvent(event:ScriptEvent):Void
2023-05-17 16:42:58 -04:00
{
// super.dispatchEvent(event) dispatches event to module scripts.
super.dispatchEvent(event);
2024-02-13 03:03:11 -05:00
if (levelProps?.members != null && levelProps.members.length > 0)
2023-05-17 16:42:58 -04:00
{
// Dispatch event to props.
2024-02-13 03:03:11 -05:00
for (prop in levelProps.members)
2023-05-17 16:42:58 -04:00
{
ScriptEventDispatcher.callEvent(prop, event);
}
}
}
2024-03-04 21:18:40 -05:00
function selectLevel():Void
2023-05-17 16:42:58 -04:00
{
if (!currentLevel.isUnlocked())
{
2024-03-23 17:50:48 -04:00
FunkinSound.playOnce(Paths.sound('cancelMenu'));
2023-05-17 16:42:58 -04:00
return;
}
if (selectedLevel) return;
selectedLevel = true;
2024-03-23 17:50:48 -04:00
FunkinSound.playOnce(Paths.sound('confirmMenu'));
2023-05-17 16:42:58 -04:00
currentLevelTitle.isFlashing = true;
for (prop in levelProps.members)
{
prop.playConfirm();
}
Paths.setCurrentLevel(currentLevel.id);
PlayStatePlaylist.playlistSongIds = currentLevel.getSongs();
PlayStatePlaylist.isStoryMode = true;
PlayStatePlaylist.campaignScore = 0;
2023-05-17 16:42:58 -04:00
var targetSongId:String = PlayStatePlaylist.playlistSongIds.shift();
2023-05-17 16:42:58 -04:00
var targetSong:Song = SongRegistry.instance.fetchEntry(targetSongId);
PlayStatePlaylist.campaignId = currentLevel.id;
PlayStatePlaylist.campaignTitle = currentLevel.getTitle();
PlayStatePlaylist.campaignDifficulty = currentDifficultyId;
2023-05-17 16:42:58 -04:00
2024-03-04 21:18:40 -05:00
Highscore.talliesLevel = new funkin.Highscore.Tallies();
2023-05-17 16:42:58 -04:00
new FlxTimer().start(1, function(tmr:FlxTimer) {
FlxTransitionableState.skipNextTransIn = false;
FlxTransitionableState.skipNextTransOut = false;
var targetVariation:String = targetSong.getFirstValidVariation(PlayStatePlaylist.campaignDifficulty);
LoadingState.loadPlayState(
{
targetSong: targetSong,
targetDifficulty: PlayStatePlaylist.campaignDifficulty,
targetVariation: targetVariation
}, true);
2023-05-17 16:42:58 -04:00
});
}
2023-06-27 15:21:09 -04:00
function updateBackground(?previousLevelId:String = ''):Void
2023-05-17 16:42:58 -04:00
{
2023-06-27 15:21:09 -04:00
if (levelBackground == null || previousLevelId == '')
2023-05-17 16:42:58 -04:00
{
2023-06-27 15:21:09 -04:00
// Build a new background and display it immediately.
levelBackground = currentLevel.buildBackground();
levelBackground.x = 0;
levelBackground.y = 56;
levelBackground.zIndex = 100;
levelBackground.alpha = 1.0; // Not hidden.
add(levelBackground);
2023-05-17 16:42:58 -04:00
}
2023-06-27 15:21:09 -04:00
else
{
var previousLevel = LevelRegistry.instance.fetchEntry(previousLevelId);
2023-05-17 16:42:58 -04:00
2023-06-27 15:21:09 -04:00
if (currentLevel.isBackgroundSimple() && previousLevel.isBackgroundSimple())
2023-05-17 16:42:58 -04:00
{
2023-06-27 15:21:09 -04:00
var previousColor:FlxColor = previousLevel.getBackgroundColor();
var currentColor:FlxColor = currentLevel.getBackgroundColor();
if (previousColor != currentColor)
{
// Both the previous and current level were simple backgrounds.
// Fade between colors directly, rather than fading one background out and another in.
2024-02-17 04:01:06 -05:00
// cancels potential tween in progress, and tweens from there
FlxTween.cancelTweensOf(levelBackground);
FlxTween.color(levelBackground, 0.9, levelBackground.color, currentColor, {ease: FlxEase.quartOut});
2023-06-27 15:21:09 -04:00
}
else
{
// Do no fade at all if the colors aren't different.
}
}
else
{
// Either the previous or current level has a complex background.
// We need to fade the old background out and the new one in.
// Reference the old background and fade it out.
var oldBackground:FlxSprite = levelBackground;
FlxTween.tween(oldBackground, {alpha: 0.0}, 0.6,
{
ease: FlxEase.linear,
onComplete: function(_) {
remove(oldBackground);
}
});
// Build a new background and fade it in.
levelBackground = currentLevel.buildBackground();
levelBackground.x = 0;
levelBackground.y = 56;
levelBackground.alpha = 0.0; // Hidden to start.
levelBackground.zIndex = 100;
add(levelBackground);
FlxTween.tween(levelBackground, {alpha: 1.0}, 0.6,
{
ease: FlxEase.linear
});
}
}
2023-05-17 16:42:58 -04:00
}
function updateProps():Void
{
for (ind => prop in currentLevel.buildProps(levelProps.members))
2023-05-17 16:42:58 -04:00
{
prop.zIndex = 1000;
if (levelProps.members[ind] != prop) levelProps.replace(levelProps.members[ind], prop) ?? levelProps.add(prop);
2023-05-17 16:42:58 -04:00
}
refresh();
}
function updateText():Void
{
tracklistText.text = 'TRACKS\n\n';
tracklistText.text += currentLevel.getSongDisplayNames(currentDifficultyId).join('\n');
tracklistText.screenCenter(X);
tracklistText.x -= FlxG.width * 0.35;
var levelScore:Null<SaveScoreData> = Save.instance.getLevelScore(currentLevelId, currentDifficultyId);
highScore = levelScore?.score ?? 0;
// levelScore.accuracy
2023-05-17 16:42:58 -04:00
}
}