godotengine / godotengine/godot-docs

AnimatedSprite2D tutorial doesn't mention new autoplay button nor link with autoplay in API

Open
#7,266 0 comments 3 reactions 0 assignees View on GitHub
area:manual enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:**

4.0.2

**Issue description:**

Coming from https://github.com/godotengine/godot/issues/72683

The 2D animation tutorial https://docs.godotengine.org/en/stable/tutorials/2d/2d_sprite_animation.html doesn't mention the new autoplay button in the SpriteFrames window.

There is only the API https://docs.godotengine.org/en/latest/classes/class_animatedsprite2d.html with autoplay property, so it looks like everything must be done via code.

It would be nice to indicate the new UI workflow to users in the tutorial, and also link them to the autoplay property as a code alternative (e.g. when you need dynamic autoplay selection based on type of entity, or to find the initial animation to reset it).

Also mention that it's really set per AnimatedSprite2D and not per SpriteFrames, although set in the SpriteFrames panel.

I suppose API is not meant to explain all the UI stuff, but a short explanation that autoplay can also be set in UI in SpriteFrames panel, or at least a link to the tutorial page could help users (I often check the API directly in Godot so I look at it more than tutorials).

Generally speaking, it would be nice to link class API pages to appropriate tutorials because I always need to manually search for the equivalent tutorial in the doc. But that's another issue.

Both pages should mention the button and how it relates to the autoplay property. And the fact that, since autoplay is a property of AnimatedSprite2D, and not SpriteFrames, it is decided by the AnimatedSprite2D instance and therefore not shared with other AnimatedSprite2D using the same SpriteFrames, contrary to what the UI could suggest (i.e. a button on the SpriteFrames panel would usually modify SpriteFrames data, but not in this case). This allows us to have different sprites autoplaying different animations.

**URL to the documentation page:**

- https://docs.godotengine.org/en/stable/tutorials/2d/2d_sprite_animation.html
- https://docs.godotengine.org/en/latest/classes/class_animatedsprite2d.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.