Directly import frames in AnimationPlayer from AnimationSprite or a spritesheet

[jordanlis]

Describe the project you are working on

2D sidescroller

Describe the problem or limitation you are having in your project

In order to animate living beings or other objects in my game, I have the following process

• I create a spritesheet animation with multiple frames in a pixelart editor
• I create an AnimatedSprite in the node and I import the file
• Then I create an AnimationPlayer (and an AnimationTreePlayer)
• Finally, I select the AnimationPlayer and I have to click multiple times for each frame that I want to import in the animation editor. If there are 20 frames, I have to add a keyframe to the animation 20 times, it's really annoying. And this is multiplied by the number of animated entities in the game...
• Then I can start adjusting and animating the entity

Describe the feature / enhancement and how it helps to overcome the problem or limitation

I would like to have a button in the animation editor that will import a standard animation for a given AnimatedSprite. 2 things are needed :

• A new button in the animation editor
• When clicked, this button opens a node selector that requires the AnimatedSprite to be selected or the Sprite with multiple keyframes
• Optionnal if animatedSprite : Then, you will have to select the animation that you want in the AnimatedSprite
• Then, all the keyframes will be created in the Animation and spaced with a default time (1 second for example)

This will prevent clicking 2 or 3 times for creating each frame and it will improve user experience.

Describe how your proposal will work, with code, pseudo-code, mock-ups, and/or diagrams

New button

Then, you select the node and optionnally the animation in a popin

If this enhancement will not be used often, can it be worked around with a few lines of script?

No (or I don't see how, but I'm not a great developer)

Is there a reason why this should be core and not an add-on in the asset library?

AnimationPlayer is core

[KoBeWi]

I once made an editor script that will automatically create animation based on currently selected Sprite (i.e. makes hframes * vframes animation and populates the keys with consecutive frames). This is definitely doable with a plugin 🤔

[jordanlis]

I once made an editor script that will automatically create animation based on currently selected Sprite (i.e. makes hframes * vframes animation and populates the keys with consecutive frames). This is definitely doable with a plugin 🤔

I would definitely interested in using it, since I still think it should be core.

[KoBeWi]

This is the script I'm using:

tool
extends EditorScript

func _run() -> void:
    var sprite: Sprite = get_scene().get_node("Sprite")
    var animator: AnimationPlayer = get_scene().get_node("AnimationPlayer")

    assert(sprite and animator)

    var frames = sprite.hframes * sprite.vframes

    var anim_name = sprite.texture.resource_path.get_file().get_basename()
    if not animator.has_animation(anim_name):
        animator.add_animation(anim_name, Animation.new())

    var animation = animator.get_animation(anim_name)
    animation.length = frames

    var base_path = str(animator.get_node(animator.root_node).get_path_to(sprite))

    for i in frames:
        animation.track_insert_key(0, i, i)

    animation.add_track(Animation.TYPE_VALUE)
    animation.track_set_path(1, base_path + ":texture")
    animation.track_insert_key(1, 0, sprite.texture)

    animation.add_track(Animation.TYPE_VALUE)
    animation.track_set_path(2, base_path + ":hframes")
    animation.track_insert_key(2, 0, sprite.hframes)

    animation.add_track(Animation.TYPE_VALUE)
    animation.track_set_path(3, base_path + ":vframes")
    animation.track_insert_key(3, 0, sprite.vframes)

    animation.add_track(Animation.TYPE_VALUE)
    animation.track_set_path(0, base_path + ":frame")
    animation.value_track_set_update_mode(0, Animation.UPDATE_DISCRETE)

It's hardcoded to create animation in node "AnimationPlayer" based on node "Sprite", but you can modify it to your needs.