Skip to main content

IPathable

An interface that defines a pathable object.

Fields

FieldTypeDescription
GuidanyThe pathable's GUID.
BehaviorsIBehavior[]The behaviors associated with the pathable.
BehaviorFilteredboolean
Read-Only
Whether the pathable is actively filtered by a behavior.
TriggerRangenumberThe pathable's trigger range.
DistanceToPlayernumberDistance to the player.
MapIdinteger
Read-Only
The Map ID of the pathable.
CategoryCategory
Read-Only
The category the pathable belongs to.

Functions

FunctionDescription
FocusFocuses the pathable.
UnfocusUnfocuses the pathable.
InteractTriggers the pathable.


IPathable:Focus()

Focuses the pathable.

Usage

script.lua
somePathable:Focus()


IPathable:Unfocus()

Unfocuses the pathable.

Usage

script.lua
somePathable:Unfocus()


IPathable:Interact(isAutoTriggered)

Triggers the pathable.

Parameters

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

Usage

script.lua
somePathable:Interact(true)