We use cookies on this site to enhance your user experience
Collapse Sidebar

Trail

Deprecated

Trail

Deprecated

The Trail object is used to create a trail like an effect between two points. As the points move through space a texture is drawn on the plane the points define. This is commonly used to create effects to help visualize movements like tracer trails behind projectiles, footprints, tire tracks, and many other similar effects.

A diagram explaining the Trail object.
An example usage of the Trail object.

When a Trail is active it will record the position of it’s Trail/Attachment0 every frame. It then connects these positions to where the attachments were in the previous frame, creating a polygon. That polygon is then filled in with the Trail’s Trail/Color and Trail/Texture (if that Texture exists). Each segment drawn in this way will eventually fade based on the TrailEffect’s Trail/Lifetime.

Creating Trails

In order for a Trail to work properly, it must be a descendant of the `Workspace` and its attachment properties (`Trail/Attachment0` and `Trail/Attachment1`) must be set to two unique Attachments. Once this has been done the effect will create a trail as soon as either of its attachments moves.

Basic Trail

It is common practice to either store the Trail in the BasePart containing the effect’s attachments, or as a child of a Folder in the Workspace with other effects objects.

Properties

Attachment

Attachment0

Determines where the Trail will start drawing its segments.

Attachment

Attachment1

Determines where the Trail will start drawing its segments.

ColorSequence

Color

The color of the trail segments throughout the lifetime of the trail.

bool

Enabled

Toggles whether a trail will be drawn or not.

bool

FaceCamera

If set to true, the trail textures will always face the camera.

float

Lifetime

Duration of the trail in seconds.

float

LightEmission

Sets how much the colors of the trail are blended with the colors behind them.

float

LightInfluence

Sets how much the Trail is influenced by the lighting around it. The property can be set to a value from 0 to 1, with 0 being the least influenced by light and 1 being the most influenced by light.

Unlike the Trail/LightEmission property, this does not cause the trail to emit light. Instead, in determines how the trail is influenced by the light surrounding it.

For instance, let’s consider what happens to the trail if we change lighting’s Lighting/Brightness from 1 to 0. If the trail’s light influence is 1, the trail would appear much dimmer when the brightness changes. However, if the trail’s light influence is 0, the trail’s appearance will not change at all, being the trail is not affected by lighting.

Note

  • Changing this property immediately affects all existing and future trail segments.

  • This property is not related to the dynamic lighting engine of Roblox. As suggested in the documentation for Trail/LightEmission, it is recommended to create parts with PointLights that follow the path of the trail if you need your trail to emit light.

float

MaxLength

Sets the maximum length of the trail.

float

MinLength

Minimum length of a trail’s segment in studs.

Content

Texture

The texture to display on the trail.

float

TextureLength

Sets length of texture if Trail/TextureMode is Wrap or Static. If mode is Stretch sets number of times texture will repeat.

TextureMode

TextureMode

Sets how the Texture will be drawn.

NumberSequence

Transparency

Sets the transparency of the Trail’s segments over the trail’s Trail/Lifetime.

NumberSequence

WidthScale

A DataType/NumberSequence that scales the width of the Trail over the course of its lifetime.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

void

Clear ( )

Clears the segments of the trail.

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.