godot-docs icon indicating copy to clipboard operation
godot-docs copied to clipboard

AnimationTree documentation is unclear on how to do some stuff you can do with AnimationPlayer

Open silverweed opened this issue 4 years ago • 2 comments

Your Godot version: 3.2.2

Issue description: This PR clarified the fact that, if you have an AnimationTree, certain fields and methods of the linked AnimationPlayer return bogus values. It also added a vague statement to the doc that says: "Playback and transitions should be handled using only the AnimationTree and its constituent AnimationNode(s).".

However it's still totally obscure to me how to achieve things like:

  • getting the current animation (equivalent of AnimationPlayer.current_animation)
  • getting the current animation position (current_animation_position)
  • getting the current animation length (current_animation_length)
  • etc. (basically all the list reported in the PR linked above).

It's also unclear how to get a specific AnimationNode from the AnimationTree in order to even start "using" it like the doc is suggesting.

Are there ways to do the stuff listed above? Could the doc be updated to point users to the right direction?

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/classes/class_animationnode.html#class-animationnode

silverweed avatar Nov 18 '20 19:11 silverweed

Not sure if you still care, but it seems the things in that list are not really possible. Check this comment/thread. Signals and other information like current animation that the AnimationPlayer provides aren't considered in an AnimationTree.

It's also unclear how to get a specific AnimationNode from the AnimationTree

That I agree with. I've opened a new issue for that: https://github.com/godotengine/godot-docs/issues/6079

Hiiamwilliam avatar Aug 15 '22 19:08 Hiiamwilliam

Thanks for the reply. I don't remember how I solved my specific case that made me open this issue (or even what it was) but I think it's very useful to add this information to the docs (as it's a problem that I bump into relatively regularly - but not as regularly as to actually remember how to solve it right away), so thank you for opening the issue!

silverweed avatar Aug 16 '22 09:08 silverweed