This example explains how to both clear a trail's drawn segments and disable
the trail to prevent new segments from being drawn. New segments will not be
drawn until the trails `Class.Trail.Enabled` property is set to `true`.

In order for this example to be properly demonstrated, we must first create a
`BasePart` that will be the parent of our trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

To demo that the `Class.Trail:Clear()` function erases any existing trail
segments, the example relies on `TweenService`'s `Class.TweenService:Create()`
to move _part_ back and forth to constantly draw a trail. Every 3 seconds of
this motion, the trail segments are cleared and the trail is toggled between
disabled and enabled.

In order for the example to work properly, the example implements a function
named `tweenPart` that tweens the part back and forth `15` studs.


Trail:Clear

Trail

This example demos the functionality of trails.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we set the `Class.Trail.Color` to a fade between blue and
white using a `Datatype.ColorSequence`. For more info on how to set a trail's
color in a script, see the `Class.Trail.Color`'s documentation.

Finally, to demo the alignment the example relies on `TweenService`'s
`Class.TweenService:Create()` to move _part_ back and forth. As the part
moves, the trail is drawn.


Trail.Attachment0

Trail.Attachment1

Trail.Brightness

This example creates a Trail with a gradient color. This means that the color
at one end of the trail is different than the color at the opposite end of the
trail, and both colors blend together as they get closer to the middle of the
trail.


This example changes the color of the trail as it is being drawn. Initially,
the color of the trail is set to blue. After waiting for 1.5 seconds, the
color of the trail is set to red.


Trail.Color

Trail.Enabled

This example demos the functionality of the FaceEnabled property.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we initially set the FaceCamera property to _true_. Then,
every 5 seconds we toggle the property to the opposite state so that the
property switches between _true_ and _false_ every few seconds. When the
property is enabled (_true_), you can rotate your camera around the trail to
demonstrate how the trail's segments always face the player's camera.

Finally, to demo the property the example relies on `TweenService`'s
`Class.TweenService:Create()` to move _part_ back and forth. As the part
moves, the trail is drawn.


Trail.FaceCamera

This example demonstrates the effects of setting and changing a trail's
Lifetime property.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we alternate between a trail Lifetime of 0.5 and 5.5 seconds
by switching between the two values every 5 seconds.

Finally, to demo the property's affect on the trail's lifetime, the example
relies on `TweenService`'s `Class.TweenService:Create()` to move _part_ back
and forth to continuously drawn a trail.


Trail.Lifetime

This example demos the functionality of the light emission property of the
trail object.


Trail.LightEmission

This example demos the trail's light influence property.

In order to do this, we must first set `Lighting`'s
`Class.Lighting.Brightness` to 0. This is done to create a better demo
lighting to demo the differences in the trail's appearance when the light
influence property changes.

Next, we create a `BasePart`, _part_, which will be the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we initially set the LightInfluence property to _1_. Then,
every 5 seconds we increment the property so that it toggles between _0_ and
_1_. When the value is _0_, the trail appears much brighter because it is not
influenced by Lighting's low brightness as compared to when the value is _1_.

Finally, to demo the property the example relies on `TweenService`'s
`Class.TweenService:Create()` to move _part_ back and forth. As the part
moves, the trail is drawn.


Trail.LightInfluence

Trail.MaxLength

Trail.MinLength

This example adds a [pawprints][1] texture to a trail object. In order for a
trail to have a texture, the Texture property must be set to the asset link of
a roblox image.

[1]: https://www.roblox.com/library/909814149/Paw-Prints


Trail.Texture

This example demos setting a trail's texture length.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we initially set the trail's texture length to 4 (and
`Class.Trail.TextureMode` to _static_). Then, to demonstrate the effects of
changing the trail length, we alternate between a trail length of 2 and 4
every 5 seconds by adding and subtracting 2 from the length. This example uses
the [pawprint](https://www.roblox.com/library/909814149/Paw-Prints) image as
its `Class.Trail.Texture`.

Finally, to demo the texture mode the example relies on `TweenService`'s
`Class.TweenService:Create()` to move _part_ back and forth. As the part
moves, the trail is drawn.


Trail.TextureLength

This example demos setting a trail's texture mode.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we set the trail's texture mode to _static_. Note that this
is just one of three possible modes, and that the example below can easily be
changed to use another mode. We also set the texture of the trail to a
[pawprint](https://www.roblox.com/library/909814149/Paw-Prints) image.

Finally, to demo the texture mode the example relies on `TweenService`'s
`Class.TweenService:Create()` to move _part_ back and forth. As the part
moves, the trail is drawn.


Trail.TextureMode

This example demos setting the transparency of a trail using a single value
sequence `Datatype.NumberSequence`.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we set the trail's transparency to 0.8 using a single value
sequence, which means that the transparency of the drawn segments is linear
and constant.

Finally, to demo the transparency the example relies on `TweenService`'s
`Class.TweenService:Create()` to move _part_ back and forth. As the part
moves, the trail is drawn.


This example demonstrates how to change the character's CameraMode to third
person using the Classic value of the `Enum.CameraMode` enum.


This example demos setting the transparency of a trail using a multi value
sequence `Datatype.NumberSequence`.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we set the trail's transparency to a multi value gradient
using a multi value sequence. This means that the transparency of the drawn
segments is a gradient consisting of a variety of transparencies, each equally
spaced out along the trail's existing segments according to the order of the
transparency value in the _keypoints_ array.

Finally, to demo the transparency the example relies on `TweenService`'s
`Class.TweenService:Create()` to move _part_ back and forth. As the part
moves, the trail is drawn.


Trail.Transparency

This example demonstrates the effects of setting and changing a trail's
WidthScale property.

In order to do this, we must first create a `BasePart`, _part_, which will be
the parent of the trail.

Then, we create two attachments, _attachment0_ and _attachment1_, both
parented to _part_. The positions of these two attachments, more importantly
the distance between them, determines where the trail is drawn as _part_
moves. It is this distance that used with the WidthScale value to determine
the width of the trail's drawn segments.

For these attachments to create a trail as described, we create a new Trail
and parent it to _part_. We then connect _attachment0_ to
`Class.Trail.Attachment0` and _attachment1_ to `Class.Trail.Attachment1`.

In this example, we rely on an array containing two values
`sizes = {0.25, 0.75}` to alternate between two WidthScale properties. To
alternate, we use a variable `i` and the formula `(i+1)%2` to flip the value
of `i` between `0` and `1`. Lastly, we set the WidthScale value using a
`Datatype.NumberSequence` to set the property to the `ith` element (1 or 2)
from `sizes`.

Finally, to demo the property's affect on the trail's lifetime, the example
relies on `TweenService`'s `Class.TweenService:Create()` to move _part_ back
and forth. As the part moves, the trail's segment lifetime (existing and new)
grows and shrinks as the property changes.


Trail.WidthScale

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

name

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

The Trail object is used to create a trail like effect between two points.


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


Defines a point and orientation relative to a parent `Class.BasePart`,
`Class.Bone`, or another `Class.Attachment`.


A gradient of color values comprised of `Datatype.ColorSequenceKeypoint`s.


A formatted string with a specific structure to reference some form of
content.


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


A series of floats across a period of time.


An object that runs connected functions upon a specific occurrence.


Describes how the texture of a `Class.Trail` or `Class.Beam` behaves.


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.