Update AnimationTrack.yaml

[lack-of-gravity-jack]

Changes

animation controller methods are deprecated in favor of directly using animator

there's some code samples I want to change but I don't know how to. Where can I find it? "Please note that AnimationPlayed is a member of both Humanoid and AnimationController which this example would also work on." <- i cant find this line but i see it on the docs page

Checks

By submitting your pull request for review, you agree to the following:

• [ x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
• [x ] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
• [x ] To the best of my knowledge, all proposed changes are accurate.

[IgnisRBX]

Hi @lack-of-gravity-jack , code samples aren't yet open sourced. Could you please tell me which sample to update (which API specifically) and then paste the full modified sample in a comment here? I'll take it from there. Thanks!

[lack-of-gravity-jack]

"Code Samples
The following code sample includes a function that prints the name of an animation whenever an AnimationTrack plays on a humanoid.

A connection is made listening to the Humanoid.AnimationPlayed and the name of the underlying animation is printed.

Please note that AnimationPlayed is a member of both Humanoid and AnimationController which this example would also work on"

Under properties: Animation
https://create.roblox.com/docs/reference/engine/classes/AnimationTrack#Animation

Suggested edit: change the description text above the code sample to remove references to Humanoid.AnimationPlayed and AnimationController.AnimationPlayed, change the code sample to use Humanoid.Animator.AnimationPlayed:Connect()
event

[lack-of-gravity-jack]

Code Samples
The following code sample includes a function that prints the name of an animation whenever an AnimationTrack is played.

This script can be placed in a model with a Class.Humanoid child. The Humanoid contains an Class.Animator child, the Animator.AnimationPlayed event of which is connected to a function that prints the name of a playing Class.AnimationTrack.

Listen For New Animations
local function listenForNewAnimations(Animator)
Animator.AnimationPlayed:Connect(function(animationTrack)
local animationName = animationTrack.Animation.Name
print("Animation playing " .. animationName)
end)
end

local Animator = script.Parent.Humanoid.Animator

listenForNewAnimations(Animator)

[IgnisRBX]

Cool. So for the first code sample, I'm planning to change it to this (remove the arbitrary function and make it wait for an Animator to connect the event to).

I'm hesitant to add another WaitForChild() here, but it's probably safer than FindFirstChildWhichIsA("Animator").

local humanoid = script.Parent:WaitForChild("Humanoid")
local animator = humanoid:WaitForChild("Animator")

animator.AnimationPlayed:Connect(function(animationTrack)
	local animationName = animationTrack.Animation.Name
	print("Animation playing " .. animationName)
end)

[IgnisRBX]

FYI, Humanoid.AnimationPlayed and AnimationController.AnimationPlayed still exist in the docs, but you have to toggle the "Show Deprecated" switch to see them.

[lack-of-gravity-jack]

The Humanoid and AniamtionController's .AnimationPlayed events are deprecated, so I figured the AnimationTrack doc page should get rid of the code samples that use the event directly from a Humanoid

The changed code sample looks good. I don't get why there was an arbitrary function to set up the listener in the original either.

[IgnisRBX]

Nice! I'll merge this and also update the code sample.