Route Distance (Flowgraph Node)

Overview

• Node Name: Route Distance
• Category: repeat_instant
• File: extensions/flowgraph/nodes/util/closestPath.lua

Finds the approximate remaining distance along a navgraph route from a tracked position. Supports both two-point and multi-waypoint routes.

Pin Schema

Input Pins

Output Pins

Internals

Key Methods

Editor Properties

How It Works

1. When setRoute is triggered, creates a new gameplay/route/route instance.
2. In two-point mode, calls route:setupPathMulti({posB, posA}) (note reversed order).
3. In waypoints mode, calls route:setupPathMulti(waypoints).
4. On each frame, if trackedPos has changed, calls route:trackPosition(trackedPos).
5. Outputs route.path[1].distToTarget as the remaining distance.

Usage Example

-- Create a route and track distance:
local route = require('/lua/ge/extensions/gameplay/route/route')()
route:setupPathMulti({vec3(startPos), vec3(endPos)})

-- Each frame:
route:trackPosition(vec3(currentPos))
local remaining = route.path[1].distToTarget

-- In flowgraph:
-- [Set Route impulse] → [Route Distance] → dist → [Compare/Display]
--    ↑ posA, posB              ↑ trackedPos (from vehicle)

Key Dependencies

• gameplay/route/route - route calculation along navgraph
• route:setupPathMulti() - multi-waypoint route setup
• route:trackPosition() - updates position along route

See Also

• Closest Road (Flowgraph Node) - Related reference
• Custom Lua (Flowgraph Node) - Related reference
• Distance Between (Flowgraph Node) - Related reference
• FlowGraph Guide - Guide