Get Navgraph Route

Overview

• Node Name: Get Navgraph Route
• Category: once_instant
• File: extensions/flowgraph/nodes/util/routePointToPoint.lua

Finds a navgraph route between two world positions. Snaps each position to the closest navgraph node, then computes a path using the map pathfinder.

Pin Schema

Input Pins

Output Pins

Internals

Key Methods

Route Calculation

1. For each position (posA, posB), calls map.findClosestRoad() to get the two nearest nodes.
2. Selects the closer of the two nodes by squared distance comparison.
3. Calls map.getPath(nodeA, nodeB, nil, penalty) where penalty is 1000 for legal routes or 1 for unrestricted.

Legal vs Unrestricted Routes

• Legal route (legalRoute = true): Uses a high penalty (1000) for wrong-way traversal, effectively forcing legal directions.
• Unrestricted (legalRoute = false): Uses penalty of 1 so wrong-way roads are treated the same as normal.

How It Works

1. Converts posA and posB from tables to vec3.
2. Finds the nearest navgraph road nodes for both positions.
3. Picks the closer node of the two candidates at each end.
4. Runs the map pathfinder between the two nodes.
5. Outputs the resulting waypoint array, suitable for AI driving or route display.

Usage Example

-- Find a legal route between two positions:
-- posA = {100, 200, 30}  -- start world position
-- posB = {500, 800, 35}  -- finish world position
-- legalRoute = true
-- Output: {"wp_001", "wp_002", "wp_003", ...}

-- Use with AI Follow Waypoints node:
-- Connect navgraphRoute output → AI Follow Waypoints navgraphPath input

Key Dependencies

• map.findClosestRoad() - finds nearest navgraph road from a position
• map.getPath() - navgraph A* pathfinder
• map.getMap().nodes - navgraph node data

See Also

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