Skip to main content

Trail

A marker pack trail.

note

A majority of these fields simply reflect the trail attributes (any without a description). More information on attributes can be found in the attributes section.

Fields

FieldTypeDescription
Alphanumber
AnimationSpeednumber
BehaviorFilteredboolean
Read-Only
Indicates if the trail is actively filtered by a behavior.
BehaviorsIBehavior[]A table of this trails behaviors.
CanFadeboolean
CategoryCategory
Read-Only
The parent category of this trail.
CullDirectioninteger
FadeFarnumber
FadeNearnumber
Guidany
InGameVisibilityany
IsWallboolean
MapIdinteger
Read-Only
MapVisibilityboolean
MiniMapVisibilityboolean
ResetLengthnumber
TextureTexture
TintColor
TrailSampleColorColorThe color of the trail on the minimap.
TrailScalenumber
TriggerRangenumber

Functions

FunctionDescription
FocusFocuses the trail.
InteractTriggers the trail.
UnfocusUnfocuses the trail.
RemoveRemoves the trail.
GetBehaviorReturns any matching behavior by its type name.


Trail:Focus()

Focuses the trail.

Usage

script.lua
someTrail:Focus()


Trail:Interact(isAutoTriggered)

Triggers the trail.

Parameters

ParameterTypeDescription
isAutoTriggeredbooleanIndicates if the trigger was from an auto trigger or if it was manually triggered.

Usage

script.lua
someTrail:Interact(true)


Trail:Unfocus()

Unfocuses the trail.

Usage

script.lua
someTrail:Unfocus()


Trail:Remove()

Removes the trail.

Usage

script.lua
someTrail:Remove()


Trail:GetBehavior(behaviorName)

Returns any matching behavior by its type name.

Parameters

ParameterTypeDescription
behaviorNamestringThe name of the behavior type.

Returns | IBehavior

The behavior.

Usage

script.lua
local aBehavior = someTrail:GetBehavior("someBehaviorName")