Improve death counter in pause menu

Author: TerraFail451

source/funkin/data/freeplay/player/PlayerData.hx

@@ -31,6 +31,18 @@ class PlayerData
   @:default(false)
   public var showUnownedChars:Bool = false;
 
+  /**
+   * The name used for the character's type of death as seen on the pause menu.
+   */
+  @:optional
+  public var deathName:String = 'Deaths';
+
+  /**
+   * The name used for the character's type of death as seen on the pause menu when the death count is at 1.
+   */
+  @:optional
+  public var deathNameSingular:String = 'Death';
+
   /**
    * The default sticker pack to use for songs featuring this playable character.
    * Can be overridden by specific songs.

source/funkin/play/PauseSubState.hx

@@ -458,8 +458,16 @@ class PauseSubState extends MusicBeatSubState
     metadataDifficulty.scrollFactor.set(0, 0);
     metadata.add(metadataDifficulty);
 
-    metadataDeaths = new FlxText(20, metadataDifficulty.y + 32, camera.width - Math.max(40, funkin.ui.FullScreenScaleMode.gameNotchSize.x),
-      '${PlayState.instance?.deathCounter} Blue Balls');
+    if (PlayState.instance.deathCounter != 1)
+    {
+      metadataDeaths = new FlxText(20, metadataDifficulty.y + 32, camera.width - Math.max(40, funkin.ui.FullScreenScaleMode.gameNotchSize.x),
+        '${PlayState.instance?.deathCounter} Deaths');
+    }
+    else
+    {
+      metadataDeaths = new FlxText(20, metadataDifficulty.y + 32, camera.width - Math.max(40, funkin.ui.FullScreenScaleMode.gameNotchSize.x),
+        '${PlayState.instance?.deathCounter} Death');
+    }
     metadataDeaths.setFormat(Paths.font('vcr.ttf'), 32, FlxColor.WHITE, FlxTextAlign.RIGHT);
     metadataDeaths.scrollFactor.set(0, 0);
     metadata.add(metadataDeaths);
@@ -944,10 +952,30 @@ class PauseSubState extends MusicBeatSubState
     }
     #end
 
+    var playerCharacterId = PlayerRegistry.instance.getCharacterOwnerId(PlayState.instance.currentChart.characters.player);
+    var playerCharacter = PlayerRegistry.instance.fetchEntry(playerCharacterId ?? Constants.DEFAULT_CHARACTER);
+
     switch (this.currentMode)
     {
       case Standard | Difficulty:
-        metadataDeaths.text = '${PlayState.instance?.deathCounter} Blue Balls';
+        if (PlayState.instance.deathCounter != 1)
+        {
+          metadataDeaths.text = '${PlayState.instance?.deathCounter} ${playerCharacter.getDeathName()}';
+        }
+        /**
+         * Singularize the character's type of death if the death count equals 1.
+         * Print singular death name only if using default plural death name (meaning singular death name is likely also default),
+         * or not using default singular death name (meaning plural death name is likely also not default).
+         */
+        else if (playerCharacter.getDeathName() == "Deaths" || playerCharacter.getDeathNameSingular() != "Death")
+        {
+          metadataDeaths.text = '${PlayState.instance?.deathCounter} ${playerCharacter.getDeathNameSingular()}';
+        }
+        // If using default singular death name, but custom plural death name, print the plural death name.
+        else
+        {
+          metadataDeaths.text = '${PlayState.instance?.deathCounter} ${playerCharacter.getDeathName()}';
+        }
       case Charting:
         metadataDeaths.text = 'Chart Editor Preview';
       case Conversation:

source/funkin/ui/freeplay/charselect/PlayableCharacter.hx

@@ -69,6 +69,22 @@ class PlayableCharacter implements IRegistryEntry<PlayerData>
     return false;
   }
 
+  /**
+   * Retrieve the name of the character's type of death.
+   */
+  public function getDeathName():String
+  {
+    return _data?.deathName ?? "Deaths";
+  }
+
+  /**
+   * Retrieve the name of the character's type of death in singular form.
+   */
+  public function getDeathNameSingular():String
+  {
+    return _data?.deathNameSingular ?? "Death";
+  }
+
   public function getStickerPackID():String
   {
     return _data?.stickerPack ?? Constants.DEFAULT_STICKER_PACK;