Merge 6b4730e9b1 into d0f0974d1e

[CHORE] Updates example_mods's API version up to 0.7.0

.github/ISSUE_TEMPLATE/bug.yml

@@ -59,7 +59,7 @@ body:
     attributes:
       label: Version
       description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
-      placeholder: ex. 0.7.3
+      placeholder: ex. 0.7.4
     validations:
       required: true
 

.github/ISSUE_TEMPLATE/charting.yml

@@ -36,7 +36,7 @@ body:
     attributes:
       label: Version
       description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
-      placeholder: ex. 0.7.3
+      placeholder: ex. 0.7.4
     validations:
       required: true
 

.github/ISSUE_TEMPLATE/compiling.yml

@@ -36,7 +36,7 @@ body:
     attributes:
       label: Version
       description: Which version are you compiling? The game version is in the bottom left corner of the main menu or in the project.hxp file.
-      placeholder: ex. 0.7.3
+      placeholder: ex. 0.7.4
     validations:
       required: true
 

.github/ISSUE_TEMPLATE/crash.yml

@@ -60,7 +60,7 @@ body:
     attributes:
       label: Version
       description: Which version are you playing on? The game version is in the bottom left corner of the main menu.
-      placeholder: ex. 0.7.3
+      placeholder: ex. 0.7.4
     validations:
       required: true
 

docs/CONTRIBUTING.md

@@ -60,7 +60,7 @@ This section provides guidelines to follow when [opening an issue](https://githu
 
 ## Requirements
 Make sure you're playing:
-- the latest version of the game (currently v0.7.3)
+- the latest version of the game (currently v0.7.4)
 - without any mods
 - on [Newgrounds](https://www.newgrounds.com/portal/view/770371) or downloaded from [itch.io](https://ninja-muffin24.itch.io/funkin)
 

example_mods/introMod/_polymod_meta.json

@@ -6,7 +6,7 @@
       "name": "EliteMasterEric"
     }
   ],
-  "api_version": "0.5.0",
+  "api_version": "0.7.0",
   "mod_version": "1.0.0",
   "license": "Apache-2.0"
 }

example_mods/testing123/_polymod_meta.json

@@ -6,7 +6,7 @@
       "name": "EliteMasterEric"
     }
   ],
-  "api_version": "0.5.0",
+  "api_version": "0.7.0",
   "mod_version": "1.0.0",
   "license": "Apache-2.0"
 }

source/funkin/api/newgrounds/NGSaveSlot.hx

@@ -0,0 +1,156 @@
+package funkin.api.newgrounds;
+
+#if FEATURE_NEWGROUNDS
+import io.newgrounds.utils.SaveSlotList;
+import io.newgrounds.objects.SaveSlot;
+import io.newgrounds.Call.CallError;
+import io.newgrounds.objects.events.Outcome;
+import funkin.save.Save;
+
+@:nullSafety
+@:access(funkin.save.Save)
+class NGSaveSlot
+{
+  public static var instance(get, never):NGSaveSlot;
+  static var _instance:Null<NGSaveSlot> = null;
+
+  static function get_instance():NGSaveSlot
+  {
+    if (_instance == null)
+    {
+      return loadInstance();
+    }
+    return _instance;
+  }
+
+  public static function loadInstance():NGSaveSlot
+  {
+    var loadedSave:NGSaveSlot = loadSlot(Save.BASE_SAVE_SLOT);
+    if (_instance == null) _instance = loadedSave;
+
+    return loadedSave;
+  }
+
+  static function loadSlot(slot:Int):NGSaveSlot
+  {
+    trace('[NEWGROUNDS] Getting save slot from ID $slot');
+
+    var saveSlot:Null<SaveSlot> = NewgroundsClient.instance.saveSlots?.getById(slot);
+
+    var saveSlotObj:NGSaveSlot = new NGSaveSlot(saveSlot);
+    return saveSlotObj;
+  }
+
+  public var ngSaveSlot:Null<SaveSlot> = null;
+
+  public function new(?ngSaveSlot:Null<SaveSlot>)
+  {
+    this.ngSaveSlot = ngSaveSlot;
+
+    #if FLX_DEBUG
+    FlxG.console.registerClass(NGSaveSlot);
+    FlxG.console.registerClass(Save);
+    #end
+  }
+
+  /**
+   * Saves `data` to the newgrounds save slot.
+   * @param data The raw save data.
+   */
+  public function save(data:RawSaveData):Void
+  {
+    var encodedData:String = haxe.Serializer.run(data);
+
+    try
+    {
+      ngSaveSlot?.save(encodedData, function(outcome:Outcome<CallError>) {
+        switch (outcome)
+        {
+          case SUCCESS:
+            trace('[NEWGROUNDS] Successfully saved save data to save slot!');
+          case FAIL(error):
+            trace('[NEWGROUNDS] Failed to save data to save slot!');
+            trace(error);
+        }
+      });
+    }
+    catch (error:String)
+    {
+      trace('[NEWGROUNDS] Failed to save data to save slot!');
+      trace(error);
+    }
+  }
+
+  public function load(?onComplete:Null<Dynamic->Void>, ?onError:Null<CallError->Void>):Void
+  {
+    try
+    {
+      ngSaveSlot?.load(function(outcome:SaveSlotOutcome):Void {
+        switch (outcome)
+        {
+          case SUCCESS(value):
+            trace('[NEWGROUNDS] Loaded save slot with the ID of ${ngSaveSlot?.id}!');
+            #if FEATURE_DEBUG_FUNCTIONS
+            trace('Save Slot Data:');
+            trace(value);
+            #end
+
+            if (onComplete != null && value != null)
+            {
+              var decodedData:Dynamic = haxe.Unserializer.run(value);
+              onComplete(decodedData);
+            }
+          case FAIL(error):
+            trace('[NEWGROUNDS] Failed to load save slot with the ID of ${ngSaveSlot?.id}!');
+            trace(error);
+
+            if (onError != null)
+            {
+              onError(error);
+            }
+        }
+      });
+    }
+    catch (error:String)
+    {
+      trace('[NEWGROUNDS] Failed to load save slot with the ID of ${ngSaveSlot?.id}!');
+      trace(error);
+
+      if (onError != null)
+      {
+        onError(RESPONSE({message: error, code: 500}));
+      }
+    }
+  }
+
+  public function clear():Void
+  {
+    try
+    {
+      ngSaveSlot?.clear(function(outcome:Outcome<CallError>) {
+        switch (outcome)
+        {
+          case SUCCESS:
+            trace('[NEWGROUNDS] Successfully cleared save slot!');
+          case FAIL(error):
+            trace('[NEWGROUNDS] Failed to clear save slot!');
+            trace(error);
+        }
+      });
+    }
+    catch (error:String)
+    {
+      trace('[NEWGROUNDS] Failed to clear save slot!');
+      trace(error);
+    }
+  }
+
+  public function checkSlot():Void
+  {
+    trace('[NEWGROUNDS] Checking save slot with the ID of ${ngSaveSlot?.id}...');
+
+    trace('  Is null? ${ngSaveSlot == null}');
+    trace('  Is empty? ${ngSaveSlot?.isEmpty() ?? false}');
+  }
+}
+#end

source/funkin/api/newgrounds/NewgroundsClient.hx

@@ -10,6 +10,7 @@ import io.newgrounds.NGLite.LoginOutcome;
 import io.newgrounds.NGLite.LoginFail;
 import io.newgrounds.objects.events.Outcome;
 import io.newgrounds.utils.MedalList;
+import io.newgrounds.utils.SaveSlotList;
 import io.newgrounds.utils.ScoreBoardList;
 import io.newgrounds.objects.User;
 
@@ -29,6 +30,7 @@ class NewgroundsClient
   public var user(get, never):Null<User>;
   public var medals(get, never):Null<MedalList>;
   public var leaderboards(get, never):Null<ScoreBoardList>;
+  public var saveSlots(get, never):Null<SaveSlotList>;
 
   private function new()
   {
@@ -236,6 +238,8 @@ class NewgroundsClient
 
     trace('[NEWGROUNDS] Submitting leaderboard request...');
     NG.core.scoreBoards.loadList(onFetchedLeaderboards);
+    trace('[NEWGROUNDS] Submitting save slot request...');
+    NG.core.saveSlots.loadList(onFetchedSaveSlots);
   }
 
   function onLoginFailed(result:LoginFail):Void
@@ -301,6 +305,13 @@ class NewgroundsClient
     // trace(funkin.api.newgrounds.Leaderboards.listLeaderboardData());
   }
 
+  function onFetchedSaveSlots(outcome:Outcome<CallError>):Void
+  {
+    trace('[NEWGROUNDS] Fetched save slots!');
+
+    NGSaveSlot.instance.checkSlot();
+  }
+
   function get_user():Null<User>
   {
     if (NG.core == null || !this.isLoggedIn()) return null;
@@ -319,6 +330,12 @@ class NewgroundsClient
     return NG.core.scoreBoards;
   }
 
+  function get_saveSlots():Null<SaveSlotList>
+  {
+    if (NG.core == null || !this.isLoggedIn()) return null;
+    return NG.core.saveSlots;
+  }
+
   static function getSessionId():Null<String>
   {
     #if js

source/funkin/play/character/BaseCharacter.hx

@@ -48,6 +48,11 @@ class BaseCharacter extends Bopper
    */
   public var debug:Bool = false;
 
+  /**
+   * The current note kind.
+   */
+  public var curNoteKind:NoteKind;
+
   /**
    * This character plays a given animation when hitting these specific combo numbers.
    */
@@ -512,21 +517,41 @@ class BaseCharacter extends Bopper
   public override function onNoteHit(event:HitNoteScriptEvent)
   {
     super.onNoteHit(event);
-
     // If another script cancelled the event, don't do anything.
     if (event.eventCanceled) return;
+    curNoteKind = NoteKindManager.getNoteKind(event.note.noteData.kind);
 
     if (event.note.noteData.getMustHitNote() && characterType == BF)
     {
-      // If the note is from the same strumline, play the sing animation.
-      this.playSingAnimation(event.note.noteData.getDirection(), false);
-      holdTimer = 0;
+      if (curNoteKind != null)
+      {
+        if (!curNoteKind.noanim)
+        {
+          this.playSingAnimation(event.note.noteData.getDirection(), false, curNoteKind?.suffix);
+          holdTimer = 0;
+        }
+      }
+      else
+      {
+        this.playSingAnimation(event.note.noteData.getDirection(), false);
+        holdTimer = 0;
+      }
     }
     else if (!event.note.noteData.getMustHitNote() && characterType == DAD)
     {
-      // If the note is from the same strumline, play the sing animation.
-      this.playSingAnimation(event.note.noteData.getDirection(), false);
-      holdTimer = 0;
+      if (curNoteKind != null)
+      {
+        if (!curNoteKind.noanim)
+        {
+          this.playSingAnimation(event.note.noteData.getDirection(), false, curNoteKind?.suffix);
+          holdTimer = 0;
+        }
+      }
+      else
+      {
+        this.playSingAnimation(event.note.noteData.getDirection(), false);
+        holdTimer = 0;
+      }
     }
     else if (characterType == GF && event.note.noteData.getMustHitNote())
     {
@@ -660,6 +685,7 @@ class BaseCharacter extends Bopper
 
     // restart even if already playing, because the character might sing the same note twice.
     // trace('Playing ${anim}...');
+
     playAnimation(anim, true);
   }
 

source/funkin/play/notes/notekind/NoteKind.hx

@@ -23,17 +23,29 @@ class NoteKind implements INoteScriptedClass
    */
   public var noteStyleId:Null<String>;
 
+  /**
+   * Whether or not the sing animation should play.
+   */
+  public var noanim:Bool;
+
+  /**
+   * The animation suffix to use.
+   */
+  public var suffix:String;
+
   /**
    * Custom parameters for the chart editor
    */
   public var params:Array<NoteKindParam>;
 
-  public function new(noteKind:String, description:String = "", ?noteStyleId:String, ?params:Array<NoteKindParam>)
+  public function new(noteKind:String, description:String = "", ?noteStyleId:String, ?params:Array<NoteKindParam>, ?anim:Bool, ?suffix:String)
   {
     this.noteKind = noteKind;
     this.description = description;
     this.noteStyleId = noteStyleId;
     this.params = params ?? [];
+    this.noanim = anim ?? false;
+    this.suffix = suffix ?? '';
   }
 
   public function toString():String

source/funkin/play/notes/notekind/NoteKindManager.hx

@@ -115,6 +115,23 @@ class NoteKindManager
     return noteStyleId;
   }
 
+  /**
+   * Retrieve custom params of the given note kind
+   * @param noteKind Name of the note kind
+   * @return Array<NoteKindParam>
+   */
+  public static function getNoteKind(noteKind:Null<String>):Null<NoteKind>
+  {
+    if (noteKind == null)
+    {
+      return null;
+    }
+    else
+    {
+      return noteKinds.get(noteKind);
+    }
+  }
+
   /**
    * Retrive custom params of the given note kind
    * @param noteKind Name of the note kind

source/funkin/save/Save.hx

@@ -1356,6 +1356,45 @@ class Save
   {
     FileUtil.saveFile(haxe.io.Bytes.ofString(this.serialize()), [FileUtil.FILE_FILTER_JSON], null, null, './save.json', 'Write save data as JSON...');
   }
+
+  #if FEATURE_NEWGROUNDS
+  public static function saveToNewgrounds():Void
+  {
+    if (_instance == null) return;
+    trace('[SAVE] Saving Save Data to Newgrounds...');
+    funkin.api.newgrounds.NGSaveSlot.instance.save(_instance.data);
+  }
+
+  public static function loadFromNewgrounds(onFinish:Void->Void):Void
+  {
+    trace('[SAVE] Loading Save Data from Newgrounds...');
+    funkin.api.newgrounds.NGSaveSlot.instance.load(function(data:Dynamic) {
+      FlxG.save.bind('$SAVE_NAME${BASE_SAVE_SLOT}', SAVE_PATH);
+
+      if (FlxG.save.status != EMPTY)
+      {
+        // best i can do in case the NG file is corrupted or something along those lines
+        var backupSlot:Int = Save.archiveBadSaveData(FlxG.save.data);
+        trace('[SAVE] Backed up current save data in case of emergency to $backupSlot!');
+      }
+
+      FlxG.save.erase();
+      FlxG.save.bind('$SAVE_NAME${BASE_SAVE_SLOT}', SAVE_PATH); // forces regeneration of the file as erase deletes it
+
+      var gameSave = SaveDataMigrator.migrate(data);
+      FlxG.save.mergeData(gameSave.data, true);
+      _instance = gameSave;
+      onFinish();
+    }, function(error:io.newgrounds.Call.CallError) {
+      var errorMsg:String = io.newgrounds.Call.CallErrorTools.toString(error);
+
+      var msg = 'There was an error loading your save data from Newgrounds.';
+      msg += '\n${errorMsg}';
+      msg += '\nAre you sure you are connected to the internet?';
+      lime.app.Application.current.window.alert(msg, "Newgrounds Save Slot Failure");
+    });
+  }
+  #end
 }
 
 /**

source/funkin/ui/options/OptionsState.hx

@@ -69,7 +69,8 @@ class OptionsState extends MusicBeatState
     optionsCodex = new Codex<OptionsMenuPageName>(Options);
     add(optionsCodex);
 
-    var options:OptionsMenu = optionsCodex.addPage(Options, new OptionsMenu());
+    var saveData:SaveDataMenu = optionsCodex.addPage(SaveData, new SaveDataMenu());
+    var options:OptionsMenu = optionsCodex.addPage(Options, new OptionsMenu(saveData));
     var preferences:PreferencesMenu = optionsCodex.addPage(Preferences, new PreferencesMenu());
     var controls:ControlsMenu = optionsCodex.addPage(Controls, new ControlsMenu());
     #if FEATURE_INPUT_OFFSETS
@@ -84,6 +85,7 @@ class OptionsState extends MusicBeatState
       #if FEATURE_INPUT_OFFSETS
       offsets.onExit.add(exitOffsets);
       #end
+      saveData.onExit.add(optionsCodex.switchPage.bind(Options));
     }
     else
     {
@@ -159,7 +161,7 @@ class OptionsMenu extends Page<OptionsMenuPageName>
 
   final CAMERA_MARGIN:Int = 150;
 
-  public function new()
+  public function new(saveDataMenu:SaveDataMenu)
   {
     super();
     add(items = new TextMenuList());
@@ -227,9 +229,19 @@ class OptionsMenu extends Page<OptionsMenuPageName>
       });
     }
     #end
-    createItem("CLEAR SAVE DATA", function() {
-      promptClearSaveData();
-    });
+
+    // no need to show an entire new menu for just one option
+    if (saveDataMenu.hasMultipleOptions())
+    {
+      createItem("SAVE DATA OPTIONS", function() {
+        codex.switchPage(SaveData);
+      });
+    }
+    else
+    {
+      createItem("CLEAR SAVE DATA", saveDataMenu.openSaveDataPrompt);
+    }
+
     #if NO_FEATURE_TOUCH_CONTROLS
     createItem("EXIT", exit);
     #else
@@ -277,7 +289,6 @@ class OptionsMenu extends Page<OptionsMenuPageName>
 
   override function update(elapsed:Float):Void
   {
-    enabled = (prompt == null);
     #if FEATURE_TOUCH_CONTROLS
     backButton.active = (!goingBack) ? !items.busy : true;
     #end
@@ -298,31 +309,6 @@ class OptionsMenu extends Page<OptionsMenuPageName>
   {
     return items.length > 2;
   }
-
-  var prompt:Prompt;
-
-  function promptClearSaveData():Void
-  {
-    if (prompt != null) return;
-    prompt = new Prompt("This will delete
-      \nALL your save data.
-      \nAre you sure?
-    ", Custom("Delete", "Cancel"));
-    prompt.create();
-    prompt.createBgFromMargin(100, 0xFFFAFD6D);
-    prompt.back.scrollFactor.set(0, 0);
-    add(prompt);
-    prompt.onYes = function() {
-      // Clear the save data.
-      funkin.save.Save.clearData();
-      FlxG.switchState(() -> new funkin.InitState());
-    };
-    prompt.onNo = function() {
-      prompt.close();
-      prompt.destroy();
-      prompt = null;
-    };
-  }
 }
 
 enum abstract OptionsMenuPageName(String) to PageName
@@ -333,4 +319,5 @@ enum abstract OptionsMenuPageName(String) to PageName
   var Mods = "mods";
   var Preferences = "preferences";
   var Offsets = "offsets";
+  var SaveData = "saveData";
 }

source/funkin/ui/options/SaveDataMenu.hx

@@ -0,0 +1,125 @@
+package funkin.ui.options;
+
+#if FEATURE_NEWGROUNDS
+import funkin.api.newgrounds.NewgroundsClient;
+#end
+import funkin.save.Save;
+
+class SaveDataMenu extends Page<OptionsState.OptionsMenuPageName>
+{
+  var items:TextMenuList;
+
+  public function new()
+  {
+    super();
+
+    add(items = new TextMenuList());
+
+    createItem("CLEAR SAVE DATA", openSaveDataPrompt);
+
+    #if FEATURE_NEWGROUNDS
+    if (NewgroundsClient.instance.isLoggedIn())
+    {
+      createItem("LOAD FROM NG", function() {
+        openConfirmPrompt("This will overwrite
+        \nALL your save data.
+        \nAre you sure?
+      ", "Overwrite", function() {
+          Save.loadFromNewgrounds(function() {
+            FlxG.switchState(() -> new funkin.InitState());
+          });
+        });
+      });
+
+      createItem("SAVE TO NG", function() {
+        openConfirmPrompt("This will overwrite
+        \nALL save data saved
+        \non NG. Are you sure?", "Overwrite", function() {
+          Save.saveToNewgrounds();
+        });
+      });
+
+      createItem("CLEAR NG SAVE DATA", function() {
+        openConfirmPrompt("This will delete
+        \nALL save data saved
+        \non NG. Are you sure?", "Delete", function() {
+          funkin.api.newgrounds.NGSaveSlot.instance.clear();
+        });
+      });
+    }
+    #end
+
+    createItem("EXIT", exit);
+  }
+
+  function createItem(name:String, callback:Void->Void, fireInstantly = false)
+  {
+    var item = items.createItem(0, 100 + items.length * 100, name, BOLD, callback);
+    item.fireInstantly = fireInstantly;
+    item.screenCenter(X);
+    return item;
+  }
+
+  override function update(elapsed:Float)
+  {
+    enabled = (prompt == null);
+    super.update(elapsed);
+  }
+
+  override function set_enabled(value:Bool)
+  {
+    items.enabled = value;
+    return super.set_enabled(value);
+  }
+
+  var prompt:Prompt;
+
+  function openConfirmPrompt(text:String, yesText:String, onYes:Void->Void, ?groupToOpenOn:Null<flixel.group.FlxGroup>):Void
+  {
+    if (prompt != null) return;
+
+    prompt = new Prompt(text, Custom(yesText, "Cancel"));
+    prompt.create();
+    prompt.createBgFromMargin(100, 0xFFFAFD6D);
+    prompt.back.scrollFactor.set(0, 0);
+    FlxG.state.add(prompt);
+
+    prompt.onYes = function() {
+      onYes();
+
+      if (prompt != null)
+      {
+        prompt.close();
+        prompt.destroy();
+        prompt = null;
+      }
+    };
+
+    prompt.onNo = function() {
+      prompt.close();
+      prompt.destroy();
+      prompt = null;
+    }
+  }
+  public function openSaveDataPrompt()
+  {
+    openConfirmPrompt("This will delete
+        \nALL your save data.
+        \nAre you sure?
+      ", "Delete", function() {
+      // Clear the save data.
+      Save.clearData();
+
+      FlxG.switchState(() -> new funkin.InitState());
+    });
+  }
+
+  /**
+   * True if this page has multiple options, excluding the exit option.
+   * If false, there's no reason to ever show this page.
+   */
+  public function hasMultipleOptions():Bool
+  {
+    return items.length > 2;
+  }
+}

source/funkin/util/WindowUtil.hx

@@ -102,12 +102,19 @@ class WindowUtil
    */
   public static final windowExit:FlxTypedSignal<Int->Void> = new FlxTypedSignal<Int->Void>();
 
+  /**
+   * Has `initWindowEvents()` been called already?
+   * This is to prevent multiple instances of the same function.
+   */
+  private static var _initializedWindowEvents:Bool = false;
+
   /**
    * Wires up FlxSignals that happen based on window activity.
    * For example, we can run a callback when the window is closed.
    */
   public static function initWindowEvents():Void
   {
+    if (_initializedWindowEvents) return; // Fix that annoying
     // onUpdate is called every frame just before rendering.
 
     // onExit is called when the game window is closed.
@@ -137,6 +144,7 @@ class WindowUtil
       }
     });
     #end
+    _initializedWindowEvents = true;
   }
 
   /**