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

Field	Type	Description
Alpha	number
AnimationSpeed	number
BehaviorFiltered	boolean	Read-Only Indicates if the trail is actively filtered by a behavior.
Behaviors	IBehavior[]	A table of this trails behaviors.
CanFade	boolean
Category	Category	Read-Only The parent category of this trail.
CullDirection	integer
FadeFar	number
FadeNear	number
Guid	any
InGameVisibility	any
IsWall	boolean
MapId	integer	Read-Only
MapVisibility	boolean
MiniMapVisibility	boolean
ResetLength	number
Texture	Texture
Tint	Color
TrailSampleColor	Color	The color of the trail on the minimap.
TrailScale	number
TriggerRange	number

Functions

Function	Description
Focus	Focuses the trail.
Interact	Triggers the trail.
Unfocus	Unfocuses the trail.
Remove	Removes the trail.
GetBehavior	Returns any matching behavior by its type name.

---

Trail:Focus()

Focuses the trail.

Usage

script.lua

someTrail:Focus()

---

Trail:Interact(isAutoTriggered)

Triggers the trail.

Parameters

Parameter	Type	Description
isAutoTriggered	boolean	Indicates 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

Parameter	Type	Description
behaviorName	string	The name of the behavior type.

Returns | IBehavior

The behavior.

Usage

script.lua

local aBehavior = someTrail:GetBehavior("someBehaviorName")