package funkin.graphics.adobeanimate; import flixel.util.FlxSignal.FlxTypedSignal; import flxanimate.FlxAnimate; import flxanimate.FlxAnimate.Settings; import flxanimate.frames.FlxAnimateFrames; import flixel.graphics.frames.FlxFrame; import flixel.system.FlxAssets.FlxGraphicAsset; import openfl.display.BitmapData; import openfl.utils.Assets; import flixel.math.FlxPoint; import flxanimate.animate.FlxKeyFrame; /** * A sprite which provides convenience functions for rendering a texture atlas with animations. */ class FlxAtlasSprite extends FlxAnimate { static final SETTINGS:Settings = { // ?ButtonSettings:Map, FrameRate: 24.0, Reversed: false, // ?OnComplete:Void -> Void, ShowPivot: false, Antialiasing: true, ScrollFactor: null, // Offset: new FlxPoint(0, 0), // This is just FlxSprite.offset }; /** * Signal dispatched when an animation advances to the next frame. */ public var onAnimationFrame:FlxTypedSignalInt->Void> = new FlxTypedSignal(); /** * Signal dispatched when a non-looping animation finishes playing. */ public var onAnimationComplete:FlxTypedSignalVoid> = new FlxTypedSignal(); var currentAnimation:String; var canPlayOtherAnims:Bool = true; public function new(x:Float, y:Float, ?path:String, ?settings:Settings) { if (settings == null) settings = SETTINGS; if (path == null) { throw 'Null path specified for FlxAtlasSprite!'; } // Validate asset path. if (!Assets.exists('${path}/Animation.json')) { throw 'FlxAtlasSprite does not have an Animation.json file at the specified path (${path})'; } super(x, y, path, settings); if (this.anim.stageInstance == null) { throw 'FlxAtlasSprite not initialized properly. Are you sure the path (${path}) exists?'; } onAnimationComplete.add(cleanupAnimation); // This defaults the sprite to play the first animation in the atlas, // then pauses it. This ensures symbols are intialized properly. this.anim.play(''); this.anim.pause(); this.anim.onComplete.add(_onAnimationComplete); this.anim.onFrame.add(_onAnimationFrame); } /** * @return A list of all the animations this sprite has available. */ public function listAnimations():Array { var mainSymbol = this.anim.symbolDictionary[this.anim.stageInstance.symbol.name]; if (mainSymbol == null) { FlxG.log.error('FlxAtlasSprite does not have its main symbol!'); return []; } return mainSymbol.getFrameLabels().map(keyFrame -> keyFrame.name).filterNull(); } /** * @param id A string ID of the animation. * @return Whether the animation was found on this sprite. */ public function hasAnimation(id:String):Bool { return getLabelIndex(id) != -1 || anim.symbolDictionary.exists(id) || anim.getByName(id) != null; } /** * @return The current animation being played. */ public function getCurrentAnimation():String { return this.currentAnimation; } var _completeAnim:Bool = false; var fr:FlxKeyFrame = null; var looping:Bool = false; public var ignoreExclusionPref:Array = []; /** * Plays an animation. * @param id A string ID of the animation to play. * @param restart Whether to restart the animation if it is already playing. * @param ignoreOther Whether to ignore all other animation inputs, until this one is done playing * @param loop Whether to loop the animation * @param startFrame The frame to start the animation on * NOTE: `loop` and `ignoreOther` are not compatible with each other! */ 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 (anim == null) return; if (id == null || id == '') id = this.currentAnimation; if (this.currentAnimation == id && !restart) { if (!anim.isPlaying) { // Resume animation if it's paused. anim.play('', restart, false, startFrame); } return; } else { // Skip if the animation doesn't exist if (!hasAnimation(id)) { trace('Animation ' + id + ' not found'); return; } } anim.onComplete.removeAll(); anim.onComplete.add(function() { if (loop) { this.anim.play(id, restart, false, startFrame); this.currentAnimation = id; } else { onAnimationComplete.dispatch(id); } }); looping = loop; // Prevent other animations from playing if `ignoreOther` is true. if (ignoreOther) canPlayOtherAnims = false; // Move to the first frame of the animation. // goToFrameLabel(id); trace('Playing animation $id'); // Only call goToFrameLabel if there is a frame label with that name. This prevents annoying warnings! if (getFrameLabelNames().indexOf(id) != -1) { goToFrameLabel(id); fr = anim.getFrameLabel(id); anim.curFrame += startFrame; } else { this.anim.play(id, restart, false, startFrame); fr = null; } this.currentAnimation = id; } override public function update(elapsed:Float) { super.update(elapsed); } /** * Returns true if the animation has finished playing. * Never true if animation is configured to loop. */ public function isAnimationFinished():Bool { return this.anim.finished; } /** * Returns true if the animation has reached the last frame. * Can be true even if animation is configured to loop. */ public function isLoopComplete():Bool { if (this.anim == null) return false; if (!this.anim.isPlaying) return false; if (fr != null) return (anim.reversed && anim.curFrame < fr.index || !anim.reversed && anim.curFrame >= (fr.index + fr.duration)); return (anim.reversed && anim.curFrame == 0 || !(anim.reversed) && (anim.curFrame) >= (anim.length - 1)); } /** * Stops the current animation. */ public function stopAnimation():Void { if (this.currentAnimation == null) return; this.anim.removeAllCallbacksFrom(getNextFrameLabel(this.currentAnimation)); goToFrameIndex(0); } function addFrameCallback(label:String, callback:Void->Void):Void { var frameLabel = this.anim.getFrameLabel(label); frameLabel.add(callback); } function goToFrameLabel(label:String):Void { this.anim.goToFrameLabel(label); } function getFrameLabelNames(?layer:haxe.extern.EitherType = null) { var labels = this.anim.getFrameLabels(layer); var array = []; for (label in labels) { array.push(label.name); } return array; } function getNextFrameLabel(label:String):String { return listAnimations()[(getLabelIndex(label) + 1) % listAnimations().length]; } function getLabelIndex(label:String):Int { return listAnimations().indexOf(label); } function goToFrameIndex(index:Int):Void { this.anim.curFrame = index; } public function cleanupAnimation(_:String):Void { canPlayOtherAnims = true; // this.currentAnimation = null; this.anim.pause(); } function _onAnimationFrame(frame:Int):Void { if (currentAnimation != null) { onAnimationFrame.dispatch(currentAnimation, frame); if (isLoopComplete()) { anim.pause(); _onAnimationComplete(); if (looping) { anim.curFrame = (fr != null) ? fr.index : 0; anim.resume(); } else { anim.curFrame--; } } } } function _onAnimationComplete():Void { if (currentAnimation != null) { onAnimationComplete.dispatch(currentAnimation); } } var prevFrames:Map = []; public function replaceFrameGraphic(index:Int, ?graphic:FlxGraphicAsset):Void { if (graphic == null || !Assets.exists(graphic)) { var prevFrame:Null = prevFrames.get(index); if (prevFrame == null) return; prevFrame.copyTo(frames.getByIndex(index)); return; } var prevFrame:FlxFrame = prevFrames.get(index) ?? frames.getByIndex(index).copyTo(); prevFrames.set(index, prevFrame); var frame = FlxG.bitmap.add(graphic).imageFrame.frame; frame.copyTo(frames.getByIndex(index)); // Additional sizing fix. @:privateAccess if (true) { var frame = frames.getByIndex(index); frame.tileMatrix[0] = prevFrame.frame.width / frame.frame.width; frame.tileMatrix[3] = prevFrame.frame.height / frame.frame.height; } } public function getBasePosition():Null { // var stagePos = new FlxPoint(anim.stageInstance.matrix.tx, anim.stageInstance.matrix.ty); var instancePos = new FlxPoint(anim.curInstance.matrix.tx, anim.curInstance.matrix.ty); var firstElement = anim.curSymbol.timeline?.get(0)?.get(0)?.get(0); if (firstElement == null) return instancePos; var firstElementPos = new FlxPoint(firstElement.matrix.tx, firstElement.matrix.ty); return instancePos + firstElementPos; } public function getPivotPosition():Null { return anim.curInstance.symbol.transformationPoint; } public override function destroy():Void { for (prevFrameId in prevFrames.keys()) { replaceFrameGraphic(prevFrameId, null); } super.destroy(); } }