This sample creates an Animation, with an AnimationId. It then creates an
AnimationTrack by loading the Animation onto a character's Humanoid, before
playing it.


The function in this code sample will play an AnimationTrack on a loop, for a
specific number of loops, before stopping the animation.

In some cases the developer may want to stop a looped animation after a
certain number of loops have completed, rather than after a certain amount of
time. This is where the DidLoop event can be used.


AnimationTrack.DidLoop

The function in this code sample plays an animationTrack and yields until
it has stopped and ended, printing at each step along the way.


AnimationTrack.Ended

Create a localscript in StarterGui and paste the following code to try out
this example.

The code in this sample will play an animation on the local character and
print whenever a keyframe that is not named "Keyframe" is reached.


The function in the following code sample provides an example of how the
AnimationTrack.KeyframeReached event can be used to link different effects to
an animation.

The function listens for any animations being played on the Humanoid (or
AnimationController), and when a new animation is played listens for a
keyframe named 'Effect' being reached. When a keyframe named 'Effect' is
reached some basic particles will be emitted. Once the animation has stopped
the connections used by the function are disconnected, in line with best
practice to avoid memory leaks.

Although the particle effect in this sample is very simple, it could be
substituted for a range of more complicated effects using the Sound, Beam,
ParticleEffect or other objects. Additionally, in many cases the developer may
only care about effects on one specific animation (rather than every animation
played on a Humanoid). In this case, only the KeyframeReached portion of this
sample would be needed.


AnimationTrack.KeyframeReached

keyframeName

The function in this code sample will play an animationTrack and yield until
it has stopped, before printing.


AnimationTrack.Stopped

The following function will play an AnimationTrack for a specific duration.
This is done by changing the speed of the animation to the length of the
animation divided by the desired playback duration. This could be used in
situations where a developer wants to play a standard animation for different
duration (for example, recharging different abilities).


In this example a player and an animation is loaded. The Length of an
AnimationTrack determines how long the track would take to play if the speed
is at 1. If the speed is adjusted, then the actual time it will take a track
to play can be computed by dividing the length by the speed.


AnimationTrack:AdjustSpeed

speed

This code sample includes a function that changes the weight of an
AnimationTrack and yields until the weight has changed to the new target
weight.

The purpose of this sample is to demonstrate how the fadeTime parameter of
AnimationTrack.ChangeWeight works. In most cases, if a developer wishes to
yield over the fadeTime it is recommended they use wait(fadeTime).


AnimationTrack:AdjustWeight

weight

fadeTime

This `LocalScript` code waits for the local player's `Humanoid` object to
load, then it creates a new `Animation` instance with the proper
`Class.Animation.AnimationId`. The animation is then loaded onto the humanoid,
creating an `AnimationTrack`, and the track is played with
`Class.AnimationTrack:Play()`. Following that, the
`Class.AnimationTrack:GetMarkerReachedSignal()` function detects when the
"KickEnd" marker is hit.


AnimationTrack:GetMarkerReachedSignal

name

This sample includes a function that will jump to the first keyframe of a
specified name in an AnimationTrack.

As AnimationTrack.TimePosition cannot be set while the animation is not
playing the function first checks to see if the animation is playing.

This sample will only work once an Animation has loaded.


AnimationTrack:GetTimeOfKeyframe

The following code sample includes two functions that demonstrate how
AdjustSpeed and TimePosition can be used to freeze an animation at a
particular point.

The first function freezes an animation at a particular point in time (defined
in seconds). The second freezes at it at a percentage (between 0 or 100) by
multiplying the percentage by the track length.

As TimePosition can not be used when an AnimationTrack is not playing, the
functions check to make sure the animation is playing before proceeding.


AnimationTrack:Play

This code sample includes a function that stops an AnimationTrack with a
specific fadeTime, and yields until the fade is completed and the weight of
the AnimationTrack is equal to zero.

The purpose of this sample is to demonstrate how the fadeTime parameter of
AnimationTrack.Stop works. In most cases, if a developer wishes to yield over
the fadeTime it is recommended they use wait(fadeTime).


AnimationTrack:Stop

AnimationTrack

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.


AnimationTrack.Animation

This code sample includes a simple function that will play an AnimationTrack
if it is not playing, or otherwise adjust its speed and weight to match the
new parameters given.


AnimationTrack.IsPlaying

AnimationTrack.Length

The animation in this example normally loops. After the player and the
animation are loaded the animation is played in a non-looped fashion then in a
looped fashion.


AnimationTrack.Looped

AnimationTrack.Priority

AnimationTrack.Speed

AnimationTrack.TimePosition

This code sample loads two animations onto the local player's Humanoid and
demonstrates how the fadeTime paramater in AnimationTrack.Play determines how
long it takes for an AnimationTrack's WeightCurrent to reach it's
WeightTarget.

As WeightCurrent and WeightTarget are floats the == operator cannot be used to
compare, instead it is more appropriate to check that the difference between
them is sufficiently small to assume the weight fade has completed.


AnimationTrack.WeightCurrent

AnimationTrack.WeightTarget

The below example would print "Part is now a child of Model".


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Instance.Changed

property

This snippet prints the names of objects as they are added to the Workspace:


Instance.ChildAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Instance.ChildRemoved

This following example will print the name of any object that is added to the
Workspace:


Instance.DescendantAdded

descendant

The following example prints the name of any descendant as it is being removed
from the Workspace:


Instance.DescendantRemoving

This sample demonstrates how an Instance being destroyed remains in place
until the connected function yields.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

This code first references an existing object in the `original` variable.
Then, it makes a copy of the object, sets the parent to that of the original,
and finally moves the copy to (0, 50, 0).


Instance:Clone

Instance:Destroy

Instance:FindFirstAncestor

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Instance:GetPropertyChangedSignal

Instance:GetTags

Instance:HasTag

Instance:IsA

Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isA

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.ClassName

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.archivable

Instance.className

/reference/engine/classes/AnimationTrack.yaml

Controls the playback of an animation on a `Class.Humanoid` or
`Class.AnimationController`. This object cannot be created, instead it is
returned by the `Class.Humanoid:LoadAnimation()` method.


An `Class.Actor` is a container for code that can be safely split into its own
thread.


References an animation asset (`AnimationId`) which can be loaded by a
`Class.Humanoid` or `Class.AnimationController`.


The AnimationPriority Enum determines how concurrently-playing AnimationTracks
contribute to the final animation.


Instance is the base class for all classes in the Roblox class hierarchy.


An object that runs connected functions upon a specific occurrence.


Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Cloud

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Managing API Keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing information about your groups.

This allows you to manage group join requests for your account.

This allows viewing information about your inventory.

This grants the ability to publish messages on behalf of users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality

This grants access to read your profile information

Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Learn how to create successful content on Roblox with comprehensive guides, code samples, reference, and tutorials.


{pageTitle} | {SiteName}

title

Unable to add to inventory

The code sample {title} has been added to your Inventory.

Version {versionNumber} includes general performance improvements and bug fixes. Check our other release notes for status on specific improvements and bugs.

Please don't include private or personal information. Maximum {maxDescriptionLength} words.

Minimum {minDescriptionLength} words required in the description.

Release Notes for Roblox Studio Version {versionNumber}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.