animation priority if it was real

Author: KoloInDaCrib

assets

@@ -523,6 +523,12 @@ class CharacterDataParser
       input.startingAnimation = DEFAULT_STARTINGANIM;
     }
 
+    if (input.animPriorityQueue == null)
+    {
+      var canDance:Bool = [for (a in input.animations) a.name].contains("danceLeft");
+      input.animPriorityQueue = ["sing*", (canDance ? "dance*" : "idle")];
+    }
+
     if (input.scale == null)
     {
       input.scale = DEFAULT_SCALE;
@@ -559,7 +565,7 @@ class CharacterDataParser
       input.flipX = DEFAULT_FLIPX;
     }
 
-    if (input.animations.length == 0 && input.startingAnimation != null)
+    if (input.animations.length == 0 && (input.startingAnimation != null || input.animPriorityQueue != null))
     {
       return null;
     }
@@ -727,6 +733,12 @@ typedef CharacterData =
    */
   var startingAnimation:Null<String>;
 
+  /**
+   * If animations are used, place them here to have some sort of priority queue.
+   * For example a queue ["sing*", "idle"] would have all animations starting with "sing" on a higher priority than idling.
+   */
+  var animPriorityQueue:Null<Array<String>>;
+
   /**
    * Whether or not the whole ass sprite is flipped by default.
    * Useful for characters that could also be played (Pico)

source/funkin/data/character/CharacterData.hx

@@ -41,6 +41,12 @@ class FlxAtlasSprite extends FlxAnimate
    */
   public var onAnimationLoop:FlxTypedSignal<String->Void> = new FlxTypedSignal();
 
+  /**
+   * The priority queue for the animations.
+   * The lower the index an animation has, the higher the priority. Animations not in this array have the highest priority.
+   */
+  public var animPriorityQueue:Array<String> = [];
+
   var currentAnimation:String = '';
 
   var canPlayOtherAnims:Bool = true;
@@ -111,8 +117,6 @@ class FlxAtlasSprite extends FlxAnimate
 
   var looping:Bool = false;
 
-  public var ignoreExclusionPref:Array<String> = [];
-
   /**
    * Plays an animation.
    * @param id A string ID of the animation to play.
@@ -125,25 +129,7 @@ class FlxAtlasSprite extends FlxAnimate
   public function playAnimation(id:String, restart:Bool = false, ignoreOther:Bool = false, loop:Bool = false, startFrame:Int = 0):Void
   {
     // Skip if not allowed to play animations.
-    if ((!canPlayOtherAnims))
-    {
-      if (this.currentAnimation == id && restart) {}
-      else if (ignoreExclusionPref != null && ignoreExclusionPref.length > 0)
-      {
-        var detected:Bool = false;
-        for (entry in ignoreExclusionPref)
-        {
-          if (StringTools.startsWith(id, entry))
-          {
-            detected = true;
-            break;
-          }
-        }
-        if (!detected) return;
-      }
-      else
-        return;
-    }
+    if (!canPlayOtherAnims && !canPlayAnimation(id)) return;
 
     if (anim == null) return;
 
@@ -204,6 +190,31 @@ class FlxAtlasSprite extends FlxAnimate
     }
   }
 
+  /**
+   * Go over the animation priority queue and see if the requested animation can be played.
+   * @param name The requested animation to play.
+   */
+  function canPlayAnimation(name:String)
+  {
+    var requestedPriority:Int = -1;
+    var currentPriority:Int = -1;
+
+    for (i in 0...animPriorityQueue.length)
+    {
+      // Format each priority queue member to fit the ereg format.
+      var queueEntry:String = "^" + animPriorityQueue[i];
+      var regFormat:String = queueEntry.replace("*", ".+");
+
+      if (regFormat.endsWith(".+")) queueEntry = queueEntry.substring(0, queueEntry.length - 1) + "$.+";
+
+      if (new EReg(regFormat, "g").match(name) && requestedPriority == -1) requestedPriority = i;
+      if (new EReg(regFormat, "g").match(getCurrentAnimation()) && currentPriority == -1) currentPriority = i;
+    }
+
+    // An animation can be played if the requestedPriority is smaller or equal to the currentPriority.
+    return requestedPriority <= currentPriority;
+  }
+
   override public function update(elapsed:Float):Void
   {
     super.update(elapsed);

source/funkin/graphics/adobeanimate/FlxAtlasSprite.hx

@@ -176,7 +176,8 @@ class AnimateAtlasCharacter extends BaseCharacter
 
     this.mainSprite = sprite;
 
-    mainSprite.ignoreExclusionPref = ["sing"];
+    var canDance:Bool = this.hasAnimation("danceLeft");
+    mainSprite.animPriorityQueue = _data.animPriorityQueue ?? ["sing*", (canDance ? "dance*" : "idle")];
 
     // This forces the atlas to recalcuate its width and height
     this.mainSprite.alpha = 0.0001;

source/funkin/play/character/AnimateAtlasCharacter.hx

@@ -160,8 +160,6 @@ class BaseCharacter extends Bopper
 
     this.characterId = id;
 
-    ignoreExclusionPref = ["sing"];
-
     _data = CharacterDataParser.fetchCharacterData(this.characterId);
     if (_data == null)
     {
@@ -179,6 +177,9 @@ class BaseCharacter extends Bopper
       this.singTimeSteps = _data.singTime;
       this.globalOffsets = _data.offsets;
       this.flipX = _data.flipX;
+
+      var canDance:Bool = this.hasAnimation("danceLeft");
+      this.animPriorityQueue = _data.animPriorityQueue ?? ["sing*", (canDance ? "dance*" : "idle")];
     }
 
     shouldBop = false;

source/funkin/play/character/BaseCharacter.hx

@@ -43,6 +43,12 @@ class Bopper extends StageProp implements IPlayStateScriptedClass
    */
   public var idleSuffix(default, set):String = '';
 
+  /**
+   * The priority queue for the animations.
+   * The lower the index an animation has, the higher the priority. Animations not in this array have the highest priority.
+   */
+  public var animPriorityQueue:Array<String> = [];
+
   /**
    * If this bopper is rendered with pixel art, disable anti-aliasing.
    * @default `false`
@@ -118,7 +124,6 @@ class Bopper extends StageProp implements IPlayStateScriptedClass
    */
   function onAnimationFinished(name:String)
   {
-    // TODO: Can we make a system of like, animation priority or something?
     if (!canPlayOtherAnims)
     {
       canPlayOtherAnims = true;
@@ -253,8 +258,6 @@ class Bopper extends StageProp implements IPlayStateScriptedClass
 
   public var canPlayOtherAnims:Bool = true;
 
-  public var ignoreExclusionPref:Array<String> = [];
-
   /**
    * @param name The name of the animation to play.
    * @param restart Whether to restart the animation if it is already playing.
@@ -263,26 +266,7 @@ class Bopper extends StageProp implements IPlayStateScriptedClass
    */
   public function playAnimation(name:String, restart:Bool = false, ignoreOther:Bool = false, reversed:Bool = false):Void
   {
-    if ((!canPlayOtherAnims))
-    {
-      var id = name;
-      if (getCurrentAnimation() == id && restart) {}
-      else if (ignoreExclusionPref != null && ignoreExclusionPref.length > 0)
-      {
-        var detected:Bool = false;
-        for (entry in ignoreExclusionPref)
-        {
-          if (StringTools.startsWith(id, entry))
-          {
-            detected = true;
-            break;
-          }
-        }
-        if (!detected) return;
-      }
-      else
-        return;
-    }
+    if (!canPlayOtherAnims && !canPlayAnimation(name)) return;
 
     var correctName = correctAnimationName(name);
     if (correctName == null) return;
@@ -297,6 +281,31 @@ class Bopper extends StageProp implements IPlayStateScriptedClass
     applyAnimationOffsets(correctName);
   }
 
+  /**
+   * Go over the animation priority queue and see if the requested animation can be played.
+   * @param name The requested animation to play.
+   */
+  function canPlayAnimation(name:String)
+  {
+    var requestedPriority:Int = -1;
+    var currentPriority:Int = -1;
+
+    for (i in 0...animPriorityQueue.length)
+    {
+      // Format each priority queue member to fit the ereg format.
+      var queueEntry:String = "^" + animPriorityQueue[i];
+      var regFormat:String = queueEntry.replace("*", ".+");
+
+      if (regFormat.endsWith(".+")) queueEntry = queueEntry.substring(0, queueEntry.length - 1) + "$.+";
+
+      if (new EReg(regFormat, "g").match(name) && requestedPriority == -1) requestedPriority = i;
+      if (new EReg(regFormat, "g").match(getCurrentAnimation()) && currentPriority == -1) currentPriority = i;
+    }
+
+    // An animation can be played if the requestedPriority is smaller or equal to the currentPriority.
+    return requestedPriority <= currentPriority;
+  }
+
   var forceAnimationTimer:FlxTimer = new FlxTimer();
 
   /**