Skip to main content

nav kit

207 tools. Generated from the plugin source; do not edit by hand.

Guide​

The nav kit manages editor-world navigation: configured agents, Recast generation settings, bounds and modifier volumes, areas and query filters, links and smart links, invokers, build state, synchronous path/polygon/tile queries, and PIE movement, crowd and avoidance tests. Coordinates and extents are centimetres; extents are half sizes. Actor references are the exact label or object name.

Set up navigation for a level (5 calls)​

  1. nav.add_bounds_volume {name, location, extent} around the walkable geometry (or nav.fit_bounds_to_actors {boundsActor, actors}).
  2. nav.build: flushes pending bounds/geometry updates and runs the engine "Build Paths", which blocks until the tiles exist. nav.get_build_status, nav.get_nav_data and nav.get_stats confirm it.
  3. nav.project_point {point} on each endpoint (a found point means the location is on the mesh).
  4. nav.find_path {start, end}: valid, partial, length, cost, navData, the waypoints and, when there is no path, the cause (start off mesh, end off mesh, or not connected).
  5. nav.diagnose_build when something is empty: it reports missing bounds/nav data, invoker-only generation without invokers, bounds without collidable geometry, unregistered bounds, auto-update off, dirty areas and static runtime generation, each with the tool that fixes it.

For quick experiments nav.create_test_floor {name, location, extent} spawns a flat static floor (engine Cube, 10 cm thick) and nav.create_test_character a Character. Both are tagged UeaNavTest; nav.remove_test_actors {actors:[...]} deletes them and refuses any other actor.

Selecting navigation data, agent and filter​

Path and projection tools (find_path, test_path, get_path_*, get_path_corridor, reachability_matrix, project_point, raycast, runtime_* equivalents) accept:

  • navData: a navigation data label from nav.list_nav_data, or
  • agent: a supported agent name from nav.list_agents (its navigation data is used), and
  • filterClass: a NavigationQueryFilter class or Blueprint path (area costs/exclusions),
  • allowPartial (paths only, default true).

With neither navData nor agent the world's default navigation data is used. Tools that edit one RecastNavMesh take navData/actor; empty means "the only RecastNavMesh" and fails with E_INVALID_ARG when there are several.

Generation settings​

  • nav.get_navmesh / nav.set_navmesh: tile size, agent radius/height/slope, cell size/height (the Default resolution on UE 5.2+), region/layer partitioning (Monotone, Watershed, ChunkyMonotone), min region area, merge size, simplification error, voxel/low-span filtering, generateNavLinks (5.5+).
  • nav.get_resolution / nav.set_resolution {resolution:'Low'|'Default'|'High', cellSize, cellHeight, agentMaxStepHeight}: Low/High exist from UE 5.2, per-resolution step height from 5.3.
  • nav.get_tile_cache / nav.set_tile_cache: fixed pool, pool size, hard limit, simultaneous jobs, empty layers, voxel cache.
  • nav.get_query_settings / nav.set_query_settings: max search nodes, heuristic scale, vertical compensation, corner offsets (no rebuild needed).
  • nav.set_runtime_generation {mode:'Static'|'Dynamic'|'DynamicModifiersOnly'}: Static navmeshes never change in PIE; use Dynamic for moving obstacles and runtime rebuilds.
  • nav.set_navmesh_properties {properties:[{key,value}]} writes any other reflected Recast field.

Rebuild (nav.build, nav.rebuild_all, or nav.rebuild_nav_data {navData} for one agent) after generation changes.

Build control​

  • nav.build, nav.rebuild_all and nav.rebuild_nav_data block until the tiles exist.
  • nav.rebuild_area {center, extent} only dirties a box; the navigation tick regenerates it, so poll nav.wait_build (off-thread) afterwards. It needs auto-update (nav.set_auto_update {enabled:true}).
  • nav.add_build_lock {flags:16} / nav.remove_build_lock bracket multi-step edits; nav.cancel_build drops queued tile work.
  • nav.get_build_history lists the builds run through nav tools in this session (duration, tiles before/after); nav.list_registered_bounds shows what the generator really uses.
  • Debug drawing: nav.get_draw_flags / nav.set_draw_flags {enable:[...], disable:[...], enableDrawing, drawOffset} (flag names vary by engine; the getter lists them). The viewport "Navigation" show flag itself is a UI setting and is not exposed.

Areas, filters and modifiers​

  • Areas: nav.create_area_blueprint {folder, name, parentClass}, nav.duplicate_area, nav.get_area, nav.set_area_defaults {area, defaultCost, fixedAreaEnteringCost, drawColor, supportedAgents}, nav.find_actors_by_area {area} (who uses it).
  • Query filters (per-agent area costs): nav.create_query_filter_blueprint, nav.set_query_filter_area {filter, areaClass, travelCost, enteringCost, excluded} (none clears an override), nav.get_query_filter, nav.remove_query_filter_area, nav.list_query_filters. Pass the filter as filterClass to the path tools or as the AI controller's default filter.
  • Modifiers: nav.add_modifier_volume, nav.set_modifier_volume, nav.add_modifier_component, nav.set_modifier_component {areaClass, extent (failsafe), includeAgentHeight}, nav.remove_modifier_component, nav.list_modifiers (volumes + components with bounds). Replacement areas (nav.set_modifier_volume_replacement, nav.set_modifier_replacement, None clears) need UE 5.5; nav.set_modifier_resolution needs 5.2 for volumes and 5.3 for components.
  • Actor relevance: nav.set_actor_nav {actor, canAffect, dynamicObstacle, areaClass} (text true/false; empty keeps the value), nav.batch_set_actor_nav (all actors must exist), nav.refresh_actor_nav, nav.list_nav_relevant_actors, nav.find_nav_blockers.
  • Simple links on a proxy (world points): nav.add_link_proxy {name, start, end}, nav.add_simple_link, nav.set_link_proxy {index, start, end}, nav.snap_links_to_navmesh, nav.set_link_properties {index, direction, areaClass, snapRadius, snapHeight, leftProjectHeight, maxFallDownLength, snapToCheapestArea, description, supportedAgents}. nav.list_simple_links and nav.get_simple_link return every field and whether each endpoint projects to the navmesh.
  • Link components on any actor (points relative to the actor): nav.add_link_component {componentName}, nav.add_link_component_link, nav.set_link_component_link, nav.remove_link_component_link, nav.get_link_component, nav.list_link_components, nav.remove_link_component; nav.set_link_properties {componentName} edits their fields.
  • Smart links (doors, ladders): nav.set_smart_link {enabled}, nav.set_smart_link_points, nav.copy_simple_to_smart_link, nav.set_smart_link_areas {enabledArea, disabledArea}, nav.set_smart_link_broadcast {radius, interval, notifyWhenEnabled, notifyWhenDisabled}, nav.set_smart_link_obstacle / nav.clear_smart_link_obstacle, nav.get_smart_link, nav.list_smart_links. Blueprint "smart link reached" logic is authored with the bp kit.
  • Checks: nav.validate_link_proxy {actor} (coincident/off-mesh endpoints, drops beyond maxFallDownLength, enabled-but-irrelevant smart links), nav.audit_links for the whole level.

Queries​

  • Reachability: nav.test_path, nav.batch_test_paths, nav.reachability_matrix {points} (all ordered pairs), nav.find_path_to_actor.
  • Corridor: nav.get_path_corridor returns the polygons crossed (ref, centre, area, tile, cost), the distinct areas and the segments that use links.
  • Points: nav.batch_project_points, nav.sample_navmesh {center, extent, spacing} (coverage fraction), nav.random_points {count, reachable}, nav.find_distance_to_wall.
  • Polygons and tiles: nav.get_poly_at, nav.get_poly_info {polyRef | point}, nav.get_polys_in_box, nav.get_tile_at {point}, nav.list_polys_in_tile, nav.list_tiles, nav.list_tile_refs (5.5+), nav.get_area_id_map, nav.has_complete_data.
  • nav.raycast_detailed (5.5+) adds whether a clear ray's end lies in the explored corridor.

Agents, crowd and avoidance​

  • Project settings: nav.get_settings, nav.list_agents, nav.get_crowd_settings (typed profiles) are read-only. nav.set_settings, nav.add_agent, nav.set_agent, nav.remove_agent, nav.set_crowd_settings and nav.set_crowd_avoidance_profile write DefaultEngine.ini (risk 4, confirm first).
  • Agent Blueprints: nav.create_agent_blueprint {folder, name, controllerClass} makes a Character Blueprint possessed by an AIController when placed or spawned; nav.get_agent_blueprint / nav.set_agent_blueprint edit RVO, nav agent radius/height/step, crouch/jump/walk/swim/fly and path-following flags. Compile and save the Blueprint afterwards.
  • Placed Characters: nav.get_rvo_avoidance / nav.set_rvo_avoidance. Invokers: nav.add_invoker, nav.set_invoker, nav.list_invokers, nav.remove_invoker.

PIE movement test​

  1. Start PIE (play.start).
  2. nav.spawn_test_agent {name, controllerName, location, crowd} spawns a Character possessed by an AIController (a DetourCrowdAIController with crowd:true); with ensureNavData (default) the PIE world also gets its default nav data actor.
  3. nav.runtime_move_to {controller, goal} or nav.runtime_move_to_actor {controller, goalActor}; watch nav.runtime_get_controller_state (status, path progress, velocity, goal, nav data, filter); nav.runtime_pause_move, nav.runtime_resume_move, nav.runtime_stop_movement.
  4. nav.runtime_find_path_for_agent {controller, goal} shows the path MoveTo would use (pawn agent properties + controller filter); nav.runtime_batch_reachability tests many pairs.
  5. Crowd and RVO: nav.runtime_get/set_crowd_agent (quality, separation, groups, simulation), nav.runtime_get/set_crowd_profile (session only), nav.runtime_get/set_rvo.
  6. Dynamic worlds: nav.runtime_spawn_link_proxy, nav.runtime_set_smart_link_enabled (open/close a door link), nav.runtime_set_obstacle, nav.runtime_update_actor_nav, nav.runtime_rebuild_area (needs Dynamic runtime generation), nav.runtime_get_invoker_locations.
  7. nav.runtime_despawn_agent removes the pawn and its controller.

Gotchas​

  • nav.build needs at least one NavMeshBoundsVolume; without one the engine does nothing.
  • A navmesh with the default "Static" runtime generation is not rebuilt in PIE; build in the editor before starting PIE, or switch to Dynamic.
  • Query tools return found:false / valid:false (not an error) when the point or path is off the mesh; they fail only when there is no navigation system or no navigation data at all.
  • Polygon references change when tiles are rebuilt; fetch fresh ones after a build.
  • nav.fit_bounds_to_level includes every actor with bounds (landscapes too); prefer nav.fit_bounds_to_actors with explicit actors.
  • Tools/nav_integration_smoke.py --project <dir> covers the asynchronous path (bounds, floor, build, nav.wait_build from an off-thread request, projections, path, cleanup) as separate MCP calls.
  • Not available: the viewport navigation show flag, OBJ export and segment-link editing.

Tools​

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

Adds a supported agent to project navigation settings.

ArgumentTypeDescription
namestringrequired. Unique supported-agent name.
radiusstringAgent radius; empty preserves it.
heightstringAgent height; empty preserves it.
stepHeightstringAgent step height; empty preserves it.
navDataClassstringOptional navigation-data class.

Returns: items, count, values, message.

Adds a NavMeshBoundsVolume with a box brush using the requested half extents.

ArgumentTypeDescription
namestringEditor label for the new actor. Default TEXT("NavBounds").
location{x,y,z}Centre in centimetres.
extent{x,y,z}Box half extents in centimetres, each greater than zero. Default FUeaVec3(1000.0,1000.0,500.0).

Returns: items, count, values, message.

Prevents automatic navigation rebuild work until a matching release call.

ArgumentTypeDescription
flagsintegerBitmask accepted by UNavigationSystemV1 build-lock APIs. Default 1.
rebuildOnReleasebooleanRebuild navigation when releasing the lock. Default true.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Adds a navigation invoker component (tiles generated around the actor when invoker-only generation is on).

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
generationRadiusnumberrequired. Positive tile generation radius in centimetres.
removalRadiusnumberrequired. Removal radius in centimetres, at least generation radius.

Returns: items, count, values, message.

Adds a NavLinkComponent with one link (points relative to the actor) to any actor.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringLink component name; empty selects the actor's only NavLinkComponent (add: name of the new component).
indexintegerLink index inside the component. Default 0.
start{x,y,z}Left point relative to the owner actor in centimetres.
end{x,y,z}Right point relative to the owner actor in centimetres. Default FUeaVec3(100.0, 0.0, 0.0).
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.

Returns: actor, component, links, count, message.

Appends a link (points relative to the actor) to a NavLinkComponent.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringLink component name; empty selects the actor's only NavLinkComponent (add: name of the new component).
indexintegerLink index inside the component. Default 0.
start{x,y,z}Left point relative to the owner actor in centimetres.
end{x,y,z}Right point relative to the owner actor in centimetres. Default FUeaVec3(100.0, 0.0, 0.0).
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.

Returns: actor, component, links, count, message.

Adds a NavLinkProxy with one simple link between two world points.

ArgumentTypeDescription
namestringEditor label for the link proxy. Default TEXT("NavLink").
start{x,y,z}required. Left endpoint in world centimetres.
end{x,y,z}required. Right endpoint in world centimetres.
bidirectionalbooleanWhether traversal is allowed in both directions. Default true.
areaClassstringOptional NavArea class path or short name.

Returns: items, count, values, message.

Adds a NavModifierComponent to an actor.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringComponent name; empty selects the actor's only modifier component.
areaClassstringNavArea class path/name; empty preserves it ("None" clears a replacement area).
extent{x,y,z}Failsafe box half extent in centimetres (used when the owner has no collision); zero keeps it.
includeAgentHeightstringExpand the modifier bottom by the agent height (true/false); empty keeps it.

Returns: items, count, values, message.

Adds a NavModifierVolume applying an area over a box.

ArgumentTypeDescription
namestringActor label/name for a new volume.
areaClassstringrequired. NavArea class path/name ("None" clears a replacement area).
location{x,y,z}Centre in centimetres.
extent{x,y,z}Positive brush half extents. Default FUeaVec3(500,500,250).
actorstringExisting actor reference for setters/components.

Returns: items, count, values, message.

Appends a simple link (world points) to a NavLinkProxy and returns its index.

ArgumentTypeDescription
actorstringrequired. NavLinkProxy actor label/name.
indexintegerSimple-link index. Default 0.
start{x,y,z}Link start in world centimetres.
end{x,y,z}Link end in world centimetres.
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.
enabledbooleanSmart link enabled state. Default true.

Returns: items, count, values, message.

Counts navigation actors, links, invokers and tiles.

No arguments.

Returns: items, count, values, message.

Audits whether each generated Recast mesh intersects any registered bounds volume.

No arguments.

Returns: issues, count.

Audits every link proxy in the level for endpoints that are off the navmesh.

No arguments.

Returns: issues, count.

Audits modifier volumes for empty bounds.

No arguments.

Returns: issues, count.

Projects up to 1000 points in one call.

ArgumentTypeDescription
pointsarray of {x,y,z}required. 1..1000 world points in centimetres.
extent{x,y,z}Projection half extent in centimetres. Default FUeaVec3(100.0,100.0,200.0).
navDatastringNavigation data label/name.
agentstringSupported agent name.

Returns: samples, count, navigable, fraction, navData.

Applies navigation relevance settings to several named actors.

ArgumentTypeDescription
actorsarray of stringrequired. Actor references to update; every one must exist or nothing changes.
canAffectstringOptional can-affect-navigation value as true or false.
dynamicObstaclestringOptional dynamic-obstacle value as true or false.
areaClassstringOptional NavArea class path or name.

Returns: items, count, values, message.

Sets the smart link enabled state on several proxies.

ArgumentTypeDescription
actorsarray of stringrequired. NavLinkProxy actor labels or names.
enabledbooleanrequired. Desired smart-link enabled state.

Returns: items, count, values, message.

Tests a batch of independent start/end pairs and returns aggregate results.

ArgumentTypeDescription
pathsarray of UeaNavPathArgsrequired. Start/end pairs in centimetres (each may carry its own selectors).

Returns: items, count, values, message.

Builds navigation for the editor world and blocks until the tiles are generated (engine Build Paths); pending bounds and octree updates are flushed first.

No arguments.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Cancels a navigation build if one is running.

No arguments.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Clears the session build history kept by the nav tools.

No arguments.

Returns: records, count, total.

Removes the smart-link box obstacle.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: links, count, message.

Copies the first simple link's endpoints into the smart link (editor helper of NavLinkProxy).

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: links, count, message.

Creates a Character Blueprint ready for AI navigation: AIController class, auto-possess placed/spawned, navigation walking capabilities.

ArgumentTypeDescription
folderstringrequired. Destination content folder.
namestringrequired. New Blueprint asset name.
controllerClassstringAIController class path or name; empty uses AIController.

Returns: blueprint, controllerClass, autoPossessAI, useRvo, rvoRadius, rvoWeight, agentRadius, agentHeight, agentStepHeight, canCrouch, canJump, canWalk, canSwim, canFly, useAccelerationForPaths, updateNavAgentWithOwnersCollision, message.

Creates a NavArea Blueprint asset (optionally child of another NavArea class).

ArgumentTypeDescription
folderstringrequired. Destination content folder.
namestringrequired. New NavArea asset name.
parentClassstringParent NavArea class path or name; empty uses NavArea.

Returns: items, count, values, message.

Creates a NavigationQueryFilter Blueprint (per-area cost overrides and exclusions for path queries and AI moves).

ArgumentTypeDescription
folderstringrequired. Destination content folder.
namestringrequired. New asset name.

Returns: filter, areas, includeFlags, excludeFlags, count, message.

Spawns a Character in the editor world (tagged UeaNavTest) as a fixture for RVO, path-to-actor and projection tests; remove it with nav.remove_test_actors.

ArgumentTypeDescription
namestringEditor label for the new actor. Default TEXT("NavBounds").
location{x,y,z}Centre in centimetres.
extent{x,y,z}Box half extents in centimetres, each greater than zero. Default FUeaVec3(1000.0,1000.0,500.0).

Returns: items, count, values, message.

Creates a flat static floor (engine Cube scaled to extent.x/extent.y, 10 cm thick, tagged UeaNavTest) for navigation tests.

ArgumentTypeDescription
namestringEditor label for the new actor. Default TEXT("NavBounds").
location{x,y,z}Centre in centimetres.
extent{x,y,z}Box half extents in centimetres, each greater than zero. Default FUeaVec3(1000.0,1000.0,500.0).

Returns: items, count, values, message.

Explains why navigation is empty or stale: missing system/bounds/nav data, invoker-only mode without invokers, disabled auto-update, empty tiles, dirty areas.

No arguments.

Returns: ready, issues, count.

Duplicates a NavArea Blueprint asset (costs, colour and agents included).

ArgumentTypeDescription
sourcestringrequired. Source NavArea Blueprint asset path or unique name.
folderstringrequired. Destination content folder.
namestringrequired. New asset name.

Returns: items, count, values, message.

Finds every level element that uses a NavArea: modifier volumes/components, obstacles, simple links, link components, smart links, replacements.

ArgumentTypeDescription
areastringrequired. NavArea class path or name.

Returns: areaClass, users, count.

Distance from a navmesh point to the nearest navmesh wall (edge) and the wall point.

ArgumentTypeDescription
point{x,y,z}required. Point on the navmesh in centimetres.
maxDistancenumberSearch limit in centimetres. Default 5000.0.
navDatastringRecastNavMesh label/name.
filterClassstringNavigationQueryFilter class; empty uses the default filter.

Returns: found, distance, wallPoint, navData.

Lists navigation-relevant components whose collision is disabled.

No arguments.

Returns: items, count, values, message.

Finds a synchronous path (points, length, cost, failure cause); navData/agent/filterClass select the data and filter.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, points, length, cost, navData, result, message.

Finds a path to a moving actor and preserves its goal tether metadata.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
goalActorstringrequired. Goal actor label or name.
tetherDistancenumberMoving-goal tether distance in centimetres. Default 50.0.

Returns: valid, partial, points, length, cost, navData, result, message.

Fits a bounds volume around explicitly supplied actor bounds.

ArgumentTypeDescription
boundsActorstringrequired. NavMeshBoundsVolume actor label or name.
actorsarray of stringActors whose combined bounds are fitted, when nonempty.
padding{x,y,z}Padding added to each fitted box dimension in centimetres. Default FUeaVec3(100.0,100.0,100.0).

Returns: items, count, values, message.

Fits a bounds volume around all navigationally relevant level actors.

ArgumentTypeDescription
boundsActorstringrequired. NavMeshBoundsVolume actor label or name.
actorsarray of stringActors whose combined bounds are fitted, when nonempty.
padding{x,y,z}Padding added to each fitted box dimension in centimetres. Default FUeaVec3(100.0,100.0,100.0).

Returns: items, count, values, message.

Reads navigation relevance and obstacle settings from an actor's primitive components.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Returns the navigation defaults of a Character Blueprint: controller, auto-possess, RVO, nav agent size/capabilities and path following flags.

ArgumentTypeDescription
blueprintstringrequired. Character Blueprint asset path or unique name.
controllerClassstringAIController class path or name.
autoPossessAIstringDisabled, PlacedInWorld, Spawned or PlacedInWorldOrSpawned.
useRvostringRVO avoidance (true/false).
rvoRadiusstringRVO consideration radius in centimetres.
rvoWeightstringRVO avoidance weight 0..1.
agentRadiusstringNavigation agent radius in centimetres.
agentHeightstringNavigation agent height in centimetres.
agentStepHeightstringNavigation agent step height in centimetres (negative = navmesh default).
canCrouchstringCan crouch (true/false).
canJumpstringCan jump (true/false).
canWalkstringCan walk (true/false).
canSwimstringCan swim (true/false).
canFlystringCan fly (true/false).
useAccelerationForPathsstringPath following drives acceleration instead of velocity (true/false).
updateNavAgentWithOwnersCollisionstringUpdate agent radius/height from the collision capsule (true/false).

Returns: blueprint, controllerClass, autoPossessAI, useRvo, rvoRadius, rvoWeight, agentRadius, agentHeight, agentStepHeight, canCrouch, canJump, canWalk, canSwim, canFly, useAccelerationForPaths, updateNavAgentWithOwnersCollision, message.

Reads NavArea defaults: costs, flags, draw colour and supported agents.

ArgumentTypeDescription
areastringrequired. NavArea class path or name.

Returns: items, count, values, message.

Returns the Recast area id to NavArea class map of a navigation data actor.

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: areas, count, navData.

Returns the combined world bounds of all NavMeshBoundsVolume actors.

No arguments.

Returns: items, count, values, message.

Returns the builds run through nav tools in this editor session (tool, duration, tiles before/after), newest first.

ArgumentTypeDescription
limitintegerMaximum records returned, newest first (1..500). Default 20.

Returns: records, count, total.

Returns navigation build state, task count and actor counts.

No arguments.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Returns project crowd manager settings and every avoidance profile, typed.

No arguments.

Returns: maxAgents, maxAgentRadius, maxAvoidedAgents, maxAvoidedWalls, profiles, message.

Returns every RecastNavMesh debug-draw flag supported by this engine version, the master drawing switch and the draw offset.

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: navData, enableDrawing, flags, drawOffset, message.

Returns every link of one NavLinkComponent with all fields and endpoint projection status.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringLink component name; empty selects the actor's only NavLinkComponent (add: name of the new component).
indexintegerLink index inside the component. Default 0.
start{x,y,z}Left point relative to the owner actor in centimetres.
end{x,y,z}Right point relative to the owner actor in centimetres. Default FUeaVec3(100.0, 0.0, 0.0).
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.

Returns: actor, component, links, count, message.

Returns the proxy summary: simple/segment link counts and smart link state.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Returns one NavModifierComponent's areas.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringComponent name; empty selects the actor's only modifier component.
areaClassstringNavArea class path/name; empty preserves it ("None" clears a replacement area).
extent{x,y,z}Failsafe box half extent in centimetres (used when the owner has no collision); zero keeps it.
includeAgentHeightstringExpand the modifier bottom by the agent height (true/false); empty keeps it.

Returns: items, count, values, message.

Returns a NavModifierVolume's bounds and areas.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Returns one navigation data actor typed: agent, runtime generation, registration, default flag, drawing, tile count and bounds.

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: navData, count, message.

Returns the main RecastNavMesh generation settings of the only RecastNavMesh in the level.

No arguments.

Returns: items, count, values, message.

Returns the aggregate bounds occupied by the generated Recast mesh.

No arguments.

Returns: items, count, values, message.

Reads named reflected Recast fields without changing the navmesh.

ArgumentTypeDescription
propertiesarray of UeaKeyValuerequired. Property/value pairs on the navigation settings object.

Returns: items, count, values, message.

Finds a path and returns its polygon corridor (poly refs, centres, areas, tiles, costs) and link segments.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, navData, points, linkSegments, polys, areas, length, cost, message.

Returns the path cost with the selected navigation data and filter.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, points, length, cost, navData, result, message.

Returns the path length with the selected navigation data and filter.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, points, length, cost, navData, result, message.

Returns path length and cost in one request.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, points, length, cost, navData, result, message.

Returns the nearest polygon reference and projected point for a location.

ArgumentTypeDescription
point{x,y,z}required. World point in centimetres.
extent{x,y,z}Half extent of the projection search box in centimetres. Default FUeaVec3(100.0,100.0,200.0).
navDatastringNavigation data label/name; empty uses the agent's data or the default navigation data.
agentstringSupported agent name; empty uses navData or the default.
filterClassstringNavigationQueryFilter class; empty uses the default filter.

Returns: found, point, distance, polyRef, message.

Returns a polygon's centre, vertices, area id/class, flags, tile and neighbours (polyRef, or empty polyRef + point to use the nearest polygon).

ArgumentTypeDescription
polyRefstringPolygon reference (decimal, from nav.get_poly_at / nav.project_point); empty uses point.
point{x,y,z}Point in centimetres whose nearest polygon is described when polyRef is empty.
extent{x,y,z}Search half extent around point in centimetres. Default FUeaVec3(100.0,100.0,200.0).
navDatastringRecastNavMesh label/name; empty selects the only one.

Returns: polyRef, center, verts, areaId, areaClass, polyFlags, areaFlags, tileIndex, polyIndex, neighbors, navData.

Lists polygons overlapping a box (filtered by a query filter).

ArgumentTypeDescription
center{x,y,z}required. Box centre in centimetres.
extent{x,y,z}required. Positive half extents in centimetres.
limitintegerMaximum polygons returned (1..5000). Default 200.
navDatastringRecastNavMesh label/name.
filterClassstringNavigationQueryFilter class; empty uses the default filter.

Returns: polys, count, total, truncated, navData.

Returns the area overrides and include/exclude flags of a query filter.

ArgumentTypeDescription
filterstringrequired. NavigationQueryFilter Blueprint asset path, class path or name.

Returns: filter, areas, includeFlags, excludeFlags, count, message.

Returns the path query tuning of a RecastNavMesh: search node limits, heuristic scale, vertical compensation, corner offsets.

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: navData, maxSearchNodes, maxHierarchicalSearchNodes, heuristicScale, verticalDeviationFromGroundCompensation, useBetterOffsetsFromCorners, allowNavLinkAsPathEnd, useVirtualFilters, message.

Returns cell size, cell height and step height per navmesh resolution (Low/Default/High on UE 5.2+, one row before).

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: navData, perResolution, rows, message.

Reads RVO avoidance of a placed Character.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Returns navigation-system settings exposed safely on both supported engines.

No arguments.

Returns: items, count, values, message.

Returns one simple link with all fields and endpoint projection status.

ArgumentTypeDescription
actorstringrequired. NavLinkProxy actor label/name.
indexintegerSimple-link index. Default 0.
start{x,y,z}Link start in world centimetres.
end{x,y,z}Link end in world centimetres.
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.
enabledbooleanSmart link enabled state. Default true.

Returns: actor, component, links, count, message.

Returns the full smart-link state of a proxy: points, direction, areas, broadcast, obstacle, endpoint projection.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: links, count, message.

Returns nav mesh tile count and generation settings.

No arguments.

Returns: items, count, values, message.

Returns the tile grid coordinates under a point and the populated tile slots (layers) at those coordinates.

ArgumentTypeDescription
point{x,y,z}required. World point in centimetres.
navDatastringRecastNavMesh label/name; empty selects the only one.

Returns: tiles, count, truncated, navData, message.

Returns one populated Recast tile's bounds.

ArgumentTypeDescription
tileIndexintegerrequired. Zero-based tile index returned by list_tiles.
navDatastringRecastNavMesh label/name; empty selects the only one.
limitintegerMaximum polygons returned by list_polys_in_tile (1..5000). Default 200.

Returns: items, count, values, message.

Returns tile pool and generation job settings of a RecastNavMesh.

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: navData, fixedTilePoolSize, tilePoolSize, tileNumberHardLimit, maxSimultaneousJobs, storeEmptyTileLayers, useVoxelCache, tileSetUpdateInterval, tileSizeUU, tileCount, message.

Returns the Recast tile slot count, including currently empty slots.

No arguments.

Returns: items, count, values, message.

Tells whether every tile around a point has generated data (invoker/streaming readiness).

ArgumentTypeDescription
point{x,y,z}required. Point in centimetres.
radiusnumberRadius in centimetres. Default 1000.0.
navDatastringRecastNavMesh label/name.

Returns: complete, navData, message.

Tests whether a point projects to navigation.

ArgumentTypeDescription
point{x,y,z}required. World point in centimetres.
extent{x,y,z}Half extent of the projection search box in centimetres. Default FUeaVec3(100.0,100.0,200.0).
navDatastringNavigation data label/name; empty uses the agent's data or the default navigation data.
agentstringSupported agent name; empty uses navData or the default.
filterClassstringNavigationQueryFilter class; empty uses the default filter.

Returns: found, point, distance, polyRef, message.

Lists configured navigation agents.

No arguments.

Returns: items, count, values, message.

Lists loaded NavArea classes.

No arguments.

Returns: items, count, values, message.

Lists NavMeshBoundsVolume actors.

No arguments.

Returns: items, count, values, message.

Lists navigation invoker components in the editor level.

No arguments.

Returns: items, count, values, message.

Lists the NavLinkComponents of an actor with their link counts.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: actor, components, count.

Lists NavLinkProxy actors and their simple-link counts.

No arguments.

Returns: items, count, values, message.

Lists the NavModifierComponents of an actor.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Lists NavModifierVolume actors.

No arguments.

Returns: items, count, values, message.

Lists every modifier volume and component of the level with area, replacement, resolution and bounds.

No arguments.

Returns: modifiers, count.

Lists navigation data actors in the editor world, typed (agent, runtime generation, default flag, tiles, bounds).

No arguments.

Returns: navData, count, message.

Lists actors whose components can affect navigation, with their dynamic-obstacle components.

ArgumentTypeDescription
limitintegerMaximum entries returned (1..10000). Default 200.

Returns: actors, count, truncated.

Lists the polygons of one tile slot.

ArgumentTypeDescription
tileIndexintegerrequired. Zero-based tile index returned by list_tiles.
navDatastringRecastNavMesh label/name; empty selects the only one.
limitintegerMaximum polygons returned by list_polys_in_tile (1..5000). Default 200.

Returns: polys, count, total, truncated, navData.

Lists loaded NavigationQueryFilter classes (Blueprint filters appear once loaded or created).

No arguments.

Returns: items, count, values, message.

Lists the bounds registered with the navigation system (what the generator really uses) with their supported agents.

No arguments.

Returns: bounds, count, worldMin, worldMax.

Lists every simple link of a proxy with all fields and whether each endpoint projects to generated navigation.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: actor, component, links, count, message.

Lists the smart-link state of every NavLinkProxy in the level.

No arguments.

Returns: links, count, message.

Lists populated tiles by tile ref with grid coordinates, layer, bounds, polygon count and resolution. UE 5.5+.

ArgumentTypeDescription
navDatastringRecastNavMesh label/name; empty selects the only one.
limitintegerMaximum tiles returned (1..5000). Default 200.

Returns: tiles, count, truncated, navData, message.

Lists tile bounds for the only Recast navmesh.

No arguments.

Returns: items, count, values, message.

Projects an editor actor origin onto the navigation mesh.

ArgumentTypeDescription
actorstringrequired. Actor label or name.
extent{x,y,z}Half extent of the projection search box in centimetres (x is also the random radius). Default FUeaVec3(100.0,100.0,200.0).

Returns: found, point, distance, polyRef, message.

Projects a point onto the navmesh.

ArgumentTypeDescription
point{x,y,z}required. World point in centimetres.
extent{x,y,z}Half extent of the projection search box in centimetres. Default FUeaVec3(100.0,100.0,200.0).
navDatastringNavigation data label/name; empty uses the agent's data or the default navigation data.
agentstringSupported agent name; empty uses navData or the default.
filterClassstringNavigationQueryFilter class; empty uses the default filter.

Returns: found, point, distance, polyRef, message.

Samples a navigable point around an editor actor origin.

ArgumentTypeDescription
actorstringrequired. Actor label or name.
extent{x,y,z}Half extent of the projection search box in centimetres (x is also the random radius). Default FUeaVec3(100.0,100.0,200.0).

Returns: found, point, distance, polyRef, message.

Finds a random navigable point within a radius.

ArgumentTypeDescription
origin{x,y,z}required. Search origin in centimetres.
radiusnumberrequired. Positive radius in centimetres.

Returns: found, point, distance, polyRef, message.

Returns up to 100 random points (reachable from the origin or merely navigable) in one call.

ArgumentTypeDescription
origin{x,y,z}required. Origin in centimetres.
radiusnumberrequired. Positive radius in centimetres.
countintegerPoints requested (1..100). Default 10.
reachablebooleanOnly points reachable from the origin. Default true.
navDatastringNavigation data label/name.
agentstringSupported agent name.

Returns: points, count, navData.

Samples a reachable point around an editor actor origin.

ArgumentTypeDescription
actorstringrequired. Actor label or name.
extent{x,y,z}Half extent of the projection search box in centimetres (x is also the random radius). Default FUeaVec3(100.0,100.0,200.0).

Returns: found, point, distance, polyRef, message.

Finds a random reachable navigation point within a radius.

ArgumentTypeDescription
origin{x,y,z}required. Search origin in centimetres.
radiusnumberrequired. Positive radius in centimetres.

Returns: found, point, distance, polyRef, message.

Performs a navigation raycast between two points.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: found, point, distance, polyRef, message.

Raycasts between an editor point and an actor origin.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
goalActorstringrequired. Goal actor label or name.
tetherDistancenumberMoving-goal tether distance in centimetres. Default 50.0.

Returns: found, point, distance, polyRef, message.

Navigation raycast on a RecastNavMesh with the additional corridor result (whether a clear ray's end lies in the explored corridor). UE 5.5+.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: hit, hitLocation, distance, rayEndInCorridor, navData, message.

All-pairs reachability between 2..16 points (length and cost per ordered pair).

ArgumentTypeDescription
pointsarray of {x,y,z}required. 2..16 world points in centimetres.
navDatastringNavigation data label/name.
agentstringSupported agent name.
filterClassstringNavigationQueryFilter class.

Returns: cells, size, reachablePairs, navData, message.

Runs the same blocking full build as nav.build (use after changing RecastNavMesh generation settings).

No arguments.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Marks a box dirty so only its tiles are regenerated on the next navigation tick; poll nav.wait_build afterwards.

ArgumentTypeDescription
center{x,y,z}required. Box centre in centimetres.
extent{x,y,z}required. Positive box half extents in centimetres.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Rebuilds one navigation data actor synchronously (RebuildAll + wait), leaving the other agents' data untouched.

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Re-registers actors in the navigation octree after collision or relevance edits (marks their areas dirty).

ArgumentTypeDescription
actorsarray of stringrequired. Actor labels or object names; each must match exactly one actor.

Returns: items, count, values, message.

Re-registers every NavMeshBoundsVolume in the editor level.

No arguments.

Returns: items, count, values, message.

Re-registers one edited bounds volume with the navigation system.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Removes a named supported agent from project navigation settings.

ArgumentTypeDescription
namestringrequired. Unique supported-agent name.
radiusstringAgent radius; empty preserves it.
heightstringAgent height; empty preserves it.
stepHeightstringAgent step height; empty preserves it.
navDataClassstringOptional navigation-data class.

Returns: items, count, values, message.

Removes one NavMeshBoundsVolume actor.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Releases a navigation build lock and optionally requests its deferred rebuild.

ArgumentTypeDescription
flagsintegerBitmask accepted by UNavigationSystemV1 build-lock APIs. Default 1.
rebuildOnReleasebooleanRebuild navigation when releasing the lock. Default true.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Removes the navigation invoker component of an actor.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Removes a NavLinkComponent that was added to the actor instance.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringLink component name; empty selects the actor's only NavLinkComponent (add: name of the new component).
indexintegerLink index inside the component. Default 0.
start{x,y,z}Left point relative to the owner actor in centimetres.
end{x,y,z}Right point relative to the owner actor in centimetres. Default FUeaVec3(100.0, 0.0, 0.0).
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.

Returns: actor, components, count.

Removes one link from a NavLinkComponent.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringLink component name; empty selects the actor's only NavLinkComponent (add: name of the new component).
indexintegerLink index inside the component. Default 0.
start{x,y,z}Left point relative to the owner actor in centimetres.
end{x,y,z}Right point relative to the owner actor in centimetres. Default FUeaVec3(100.0, 0.0, 0.0).
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.

Returns: actor, component, links, count, message.

Removes a NavLinkProxy.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Removes a NavModifierComponent that was added to the actor instance.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringComponent name; empty selects the actor's only modifier component.
areaClassstringNavArea class path/name; empty preserves it ("None" clears a replacement area).
extent{x,y,z}Failsafe box half extent in centimetres (used when the owner has no collision); zero keeps it.
includeAgentHeightstringExpand the modifier bottom by the agent height (true/false); empty keeps it.

Returns: items, count, values, message.

Removes a NavModifierVolume.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Destroys one navigation data actor (its generated tiles go with it; nav.build recreates it).

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only navigation data in the world.

Returns: navData, count, message.

Removes one area override from a Blueprint query filter.

ArgumentTypeDescription
filterstringrequired. NavigationQueryFilter Blueprint asset path or unique name.
areaClassstringrequired. NavArea class path or name.
travelCoststringTravel cost override (> 0); "none" clears the override.
enteringCoststringEntering cost override (>= 0); "none" clears the override.
excludedstringExclude the area from paths (true/false).

Returns: filter, areas, includeFlags, excludeFlags, count, message.

Removes one simple link by index.

ArgumentTypeDescription
actorstringrequired. NavLinkProxy actor label/name.
indexintegerSimple-link index. Default 0.
start{x,y,z}Link start in world centimetres.
end{x,y,z}Link end in world centimetres.
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.
enabledbooleanSmart link enabled state. Default true.

Returns: items, count, values, message.

Destroys fixture actors created by nav.create_test_floor / nav.create_test_character (only actors tagged UeaNavTest are accepted).

ArgumentTypeDescription
actorsarray of stringrequired. Actor labels or names; each must carry the UeaNavTest tag set by the nav test-fixture tools.

Returns: items, count, values, message.

Tests independent start/end pairs in the PIE world.

ArgumentTypeDescription
pathsarray of UeaNavPathArgsrequired. Start/end pairs in centimetres (each may carry its own selectors).

Returns: results, count, reachable.

Cancels the PIE navigation build.

No arguments.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Destroys a PIE pawn and its controller (pass either).

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Finds a path in the PIE world (same selectors as nav.find_path).

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, points, length, cost, navData, result, message.

Finds a path from a controller's pawn to a goal with the pawn's agent properties and the controller's default filter (what MoveTo would use).

ArgumentTypeDescription
controllerstringrequired. PIE AIController label or name.
goal{x,y,z}required. Goal location in centimetres.

Returns: valid, partial, points, length, cost, navData, result, message.

Returns the PIE RecastNavMesh bounds.

No arguments.

Returns: items, count, values, message.

Returns PIE navigation build status.

No arguments.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Returns the full live state of a PIE AIController: pawn, velocity, move status, path progress, goal, focus, agent size, nav data, filter.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: controller, controllerClass, pawn, location, velocity, moveStatus, hasPath, pathLength, remainingCost, currentPathIndex, destination, currentTarget, acceptanceRadius, lastMoveReachedGoal, goalActor, focusActor, agentRadius, agentHeight, navData, filterClass, crowdAgent.

Returns the crowd following settings of a PIE DetourCrowdAIController.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: controller, registered, simulation, quality, anticipateTurns, obstacleAvoidance, separation, optimizeVisibility, optimizeTopology, pathOffset, slowdownAtGoal, separationWeight, collisionQueryRange, pathOptimizationRange, avoidanceRangeMultiplier, avoidanceGroup, groupsToAvoid, groupsToIgnore.

Returns the PIE crowd manager's avoidance profiles.

No arguments.

Returns: maxAgents, maxAgentRadius, maxAvoidedAgents, maxAvoidedWalls, profiles, message.

Returns the invoker locations and radii the PIE navigation system gathered last.

No arguments.

Returns: invokers, count, invokerOnly.

Returns path-following status and request result of a PIE AIController.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Returns the PIE RecastNavMesh summary.

No arguments.

Returns: items, count, values, message.

Reads navigation relevance of a PIE actor's primitive components.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Returns the active path of a PIE AIController.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: valid, partial, points, length, cost, navData, result, message.

Returns RVO avoidance of a PIE Character.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: actor, enabled, radius, weight, avoidanceGroup, groupsToAvoid, groupsToIgnore, avoidanceUID.

Returns the smart-link state of a PIE NavLinkProxy (points, areas, broadcast, obstacle).

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: links, count, message.

Returns the PIE RecastNavMesh tile slot count.

No arguments.

Returns: items, count, values, message.

Lists PIE navigation invoker components.

No arguments.

Returns: items, count, values, message.

Sends a PIE AIController to a location.

ArgumentTypeDescription
controllerstringrequired. PIE AIController actor label or name.
goal{x,y,z}required. Goal location in centimetres.
acceptanceRadiusnumberAcceptance radius in centimetres. Default 50.0.
stopOnOverlapbooleanStop on overlap with the goal. Default true.

Returns: items, count, values, message.

Sends a PIE AIController to an actor (the path follows the moving goal).

ArgumentTypeDescription
controllerstringrequired. PIE AIController actor label or name.
goalActorstringrequired. Goal actor label or name (PIE world).
acceptanceRadiusnumberAcceptance radius in centimetres. Default 50.0.
stopOnOverlapbooleanStop on overlap with the goal. Default true.

Returns: items, count, values, message.

Pauses the active move of a PIE AIController (keeps the path).

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: controller, controllerClass, pawn, location, velocity, moveStatus, hasPath, pathLength, remainingCost, currentPathIndex, destination, currentTarget, acceptanceRadius, lastMoveReachedGoal, goalActor, focusActor, agentRadius, agentHeight, navData, filterClass, crowdAgent.

Projects a point onto the PIE navigation data.

ArgumentTypeDescription
point{x,y,z}required. World point in centimetres.
extent{x,y,z}Half extent of the projection search box in centimetres. Default FUeaVec3(100.0,100.0,200.0).
navDatastringNavigation data label/name; empty uses the agent's data or the default navigation data.
agentstringSupported agent name; empty uses navData or the default.
filterClassstringNavigationQueryFilter class; empty uses the default filter.

Returns: found, point, distance, polyRef, message.

Returns a random navigable PIE point.

ArgumentTypeDescription
origin{x,y,z}required. PIE-world origin.
radiusnumberrequired. Positive radius in centimetres.
reachablebooleanRequire reachability from origin. Default true.

Returns: found, point, distance, polyRef, message.

Returns a random PIE navigation point (reachable or navigable).

ArgumentTypeDescription
origin{x,y,z}required. PIE-world origin.
radiusnumberrequired. Positive radius in centimetres.
reachablebooleanRequire reachability from origin. Default true.

Returns: found, point, distance, polyRef, message.

Returns a random PIE point reachable from origin.

ArgumentTypeDescription
origin{x,y,z}required. PIE-world origin.
radiusnumberrequired. Positive radius in centimetres.
reachablebooleanRequire reachability from origin. Default true.

Returns: found, point, distance, polyRef, message.

Navigation raycast in the PIE world.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: found, point, distance, polyRef, message.

Requests a full navigation build in the PIE world.

No arguments.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Marks a PIE box dirty so dynamic navigation regenerates its tiles.

ArgumentTypeDescription
center{x,y,z}required. Box centre in centimetres.
extent{x,y,z}required. Positive box half extents in centimetres.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Registers a PIE actor as navigation invoker.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
generationRadiusnumberrequired. Positive tile generation radius in centimetres.
removalRadiusnumberrequired. Removal radius in centimetres, at least generation radius.

Returns: items, count, values, message.

Resumes a paused move of a PIE AIController.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: controller, controllerClass, pawn, location, velocity, moveStatus, hasPath, pathLength, remainingCost, currentPathIndex, destination, currentTarget, acceptanceRadius, lastMoveReachedGoal, goalActor, focusActor, agentRadius, agentHeight, navData, filterClass, crowdAgent.

Changes crowd following settings of a PIE DetourCrowdAIController (quality, separation, groups, ranges, simulation state).

ArgumentTypeDescription
actorstringrequired. PIE AIController label or name (DetourCrowdAIController).
simulationstringEnabled, ObstacleOnly or Disabled.
qualitystringLow, Medium, Good or High (selects the avoidance profile).
anticipateTurnsstringtrue/false.
obstacleAvoidancestringtrue/false.
separationstringtrue/false.
optimizeVisibilitystringtrue/false.
optimizeTopologystringtrue/false.
pathOffsetstringtrue/false.
slowdownAtGoalstringtrue/false.
separationWeightstringSeparation weight (>= 0).
collisionQueryRangestringCollision query range in centimetres.
pathOptimizationRangestringPath optimization range in centimetres.
avoidanceRangeMultiplierstringAvoidance range multiplier.
avoidanceGroupstringAvoidance group bitmask.
groupsToAvoidstringGroups to avoid bitmask.
groupsToIgnorestringGroups to ignore bitmask.

Returns: controller, registered, simulation, quality, anticipateTurns, obstacleAvoidance, separation, optimizeVisibility, optimizeTopology, pathOffset, slowdownAtGoal, separationWeight, collisionQueryRange, pathOptimizationRange, avoidanceRangeMultiplier, avoidanceGroup, groupsToAvoid, groupsToIgnore.

Changes one avoidance profile of the PIE crowd manager (session only; nav.set_crowd_avoidance_profile writes the project default).

ArgumentTypeDescription
indexintegerrequired. Profile index (0..3 by default).
velocityBiasstringVelocity bias.
desiredVelocityWeightstringDesired velocity weight.
currentVelocityWeightstringCurrent velocity weight.
sideBiasWeightstringSide bias weight.
impactTimeWeightstringImpact time weight.
impactTimeRangestringImpact time range in seconds.
adaptiveDivisionsstringAdaptive divisions (1..32).
adaptiveRingsstringAdaptive rings (1..4).
adaptiveDepthstringAdaptive depth (1..10).

Returns: maxAgents, maxAgentRadius, maxAvoidedAgents, maxAvoidedWalls, profiles, message.

Turns navigation relevance of a PIE actor's primitive components on/off.

ArgumentTypeDescription
actorstringrequired. PIE actor label or name.
enabledbooleanrequired. Whether primitive components affect navigation.

Returns: items, count, values, message.

Changes RVO avoidance of a PIE Character (enable, radius, weight, groups).

ArgumentTypeDescription
actorstringrequired. PIE Character label or name.
enabledstringEnable RVO avoidance (true/false).
radiusstringConsideration radius in centimetres.
weightstringAvoidance weight 0..1.
avoidanceGroupstringAvoidance group bitmask.
groupsToAvoidstringGroups to avoid bitmask.
groupsToIgnorestringGroups to ignore bitmask.

Returns: actor, enabled, radius, weight, avoidanceGroup, groupsToAvoid, groupsToIgnore, avoidanceUID.

Enables/disables a PIE smart link (door open/closed) and notifies agents per its broadcast settings.

ArgumentTypeDescription
actorstringrequired. PIE NavLinkProxy label or name.
enabledbooleanrequired. Enable the smart link.

Returns: links, count, message.

Spawns a NavLinkProxy in the PIE world (runtime jump/door links); its smart link starts disabled.

ArgumentTypeDescription
namestringEditor label for the link proxy. Default TEXT("NavLink").
start{x,y,z}required. Left endpoint in world centimetres.
end{x,y,z}required. Right endpoint in world centimetres.
bidirectionalbooleanWhether traversal is allowed in both directions. Default true.
areaClassstringOptional NavArea class path or short name.

Returns: items, count, values, message.

Stops the movement of a PIE AIController.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Tests whether a complete PIE path exists.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, points, length, cost, navData, result, message.

Unregisters a PIE navigation invoker.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Re-registers a PIE actor in the navigation octree after it moved or changed collision (dirties its area).

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: items, count, values, message.

Validates the PIE navigation data.

No arguments.

Returns: issues, count.

Samples a box on a grid and reports which points are navigable (coverage fraction).

ArgumentTypeDescription
center{x,y,z}required. Box centre in centimetres.
extent{x,y,z}required. Positive box half extents in centimetres (z is the vertical projection range).
spacingnumberGrid spacing in centimetres (>= 10). Default 100.0.
maxSamplesintegerMaximum samples (1..2500). Default 400.
navDatastringNavigation data label/name.
agentstringSupported agent name.

Returns: samples, count, navigable, fraction, navData.

Sets navigation relevance and dynamic-obstacle properties on an actor's primitive components.

ArgumentTypeDescription
actorstringrequired. Actor label or name.
canAffectstringOptional can-affect-navigation value as true or false.
dynamicObstaclestringOptional dynamic-obstacle value as true or false.
areaClassstringOptional NavArea class path or name for shape components.

Returns: items, count, values, message.

Updates a named supported agent in project navigation settings.

ArgumentTypeDescription
namestringrequired. Unique supported-agent name.
radiusstringAgent radius; empty preserves it.
heightstringAgent height; empty preserves it.
stepHeightstringAgent step height; empty preserves it.
navDataClassstringOptional navigation-data class.

Returns: items, count, values, message.

Sets navigation defaults of a Character Blueprint (controller, auto-possess, RVO, nav agent size/capabilities, path following flags).

ArgumentTypeDescription
blueprintstringrequired. Character Blueprint asset path or unique name.
controllerClassstringAIController class path or name.
autoPossessAIstringDisabled, PlacedInWorld, Spawned or PlacedInWorldOrSpawned.
useRvostringRVO avoidance (true/false).
rvoRadiusstringRVO consideration radius in centimetres.
rvoWeightstringRVO avoidance weight 0..1.
agentRadiusstringNavigation agent radius in centimetres.
agentHeightstringNavigation agent height in centimetres.
agentStepHeightstringNavigation agent step height in centimetres (negative = navmesh default).
canCrouchstringCan crouch (true/false).
canJumpstringCan jump (true/false).
canWalkstringCan walk (true/false).
canSwimstringCan swim (true/false).
canFlystringCan fly (true/false).
useAccelerationForPathsstringPath following drives acceleration instead of velocity (true/false).
updateNavAgentWithOwnersCollisionstringUpdate agent radius/height from the collision capsule (true/false).

Returns: blueprint, controllerClass, autoPossessAI, useRvo, rvoRadius, rvoWeight, agentRadius, agentHeight, agentStepHeight, canCrouch, canJump, canWalk, canSwim, canFly, useAccelerationForPaths, updateNavAgentWithOwnersCollision, message.

Sets NavArea defaults: traversal cost, entering cost, flags, draw colour and supported agents.

ArgumentTypeDescription
areastringrequired. NavArea class path or name.
defaultCoststringDefault traversal cost; empty preserves it.
fixedAreaEnteringCoststringFixed entering cost; empty preserves it.
drawColorstringDebug draw colour as (R=,G=,B=,A=) text; empty preserves it.
supportedAgentsarray of stringSupported agent names; empty preserves the current agents.

Returns: items, count, values, message.

Turns automatic navigation rebuilds after edits on/off for this editor session.

ArgumentTypeDescription
enabledbooleanrequired. Rebuild navigation automatically after edits in this editor session.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.

Restricts a NavMeshBoundsVolume to some supported agents (empty list = all agents).

ArgumentTypeDescription
actorstringrequired. NavMeshBoundsVolume label or name.
agentsarray of stringSupported agent names; empty means every agent.

Returns: bounds, count, worldMin, worldMax.

Resizes and moves a NavMeshBoundsVolume, then notifies navigation.

ArgumentTypeDescription
actorstringrequired. Bounds-volume actor label or name.
location{x,y,z}New centre in centimetres.
extent{x,y,z}required. New positive box half extents in centimetres.

Returns: items, count, values, message.

Writes one crowd avoidance profile to project config (DefaultEngine.ini CrowdManager).

ArgumentTypeDescription
indexintegerrequired. Profile index (0..3 by default).
velocityBiasstringVelocity bias.
desiredVelocityWeightstringDesired velocity weight.
currentVelocityWeightstringCurrent velocity weight.
sideBiasWeightstringSide bias weight.
impactTimeWeightstringImpact time weight.
impactTimeRangestringImpact time range in seconds.
adaptiveDivisionsstringAdaptive divisions (1..32).
adaptiveRingsstringAdaptive rings (1..4).
adaptiveDepthstringAdaptive depth (1..10).

Returns: maxAgents, maxAgentRadius, maxAvoidedAgents, maxAvoidedWalls, profiles, message.

Writes the crowd MaxAgents to project config.

ArgumentTypeDescription
maxAgentsintegerrequired. Maximum crowd agents, from 1 to 100000.

Returns: maxAgents, maxAgentRadius, maxAvoidedAgents, maxAvoidedWalls, profiles, message.

Turns RecastNavMesh debug-draw flags on/off (names from nav.get_draw_flags), plus the master drawing switch and draw offset.

ArgumentTypeDescription
navDatastringRecastNavMesh actor label/name; empty selects the only one.
enablearray of stringFlag names to turn on (see nav.get_draw_flags for the supported list).
disablearray of stringFlag names to turn off.
enableDrawingstringOptional master drawing switch as true/false; empty keeps it.
drawOffsetstringOptional draw offset in centimetres; empty keeps it.

Returns: navData, enableDrawing, flags, drawOffset, message.

Changes the radii of the actor's only navigation invoker component.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
generationRadiusnumberrequired. Positive tile generation radius in centimetres.
removalRadiusnumberrequired. Removal radius in centimetres, at least generation radius.

Returns: items, count, values, message.

Moves one NavLinkComponent link (points relative to the actor), its direction and optional area.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringLink component name; empty selects the actor's only NavLinkComponent (add: name of the new component).
indexintegerLink index inside the component. Default 0.
start{x,y,z}Left point relative to the owner actor in centimetres.
end{x,y,z}Right point relative to the owner actor in centimetres. Default FUeaVec3(100.0, 0.0, 0.0).
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.

Returns: actor, component, links, count, message.

Sets direction, area, snap, projection heights, description and supported agents of a proxy simple link or a NavLinkComponent link.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringNavLinkComponent name; empty edits the NavLinkProxy simple links (PointLinks).
indexintegerLink index. Default 0.
directionstringBothWays, LeftToRight or RightToLeft.
areaClassstringNavArea class path/name.
snapRadiusstringEndpoint snap radius in centimetres (>= 1).
snapHeightstringEndpoint snap height in centimetres (>= 1; enables useSnapHeight).
useSnapHeightstringUse snapHeight (true/false).
leftProjectHeightstringLeft endpoint projection height in centimetres.
maxFallDownLengthstringRight endpoint maximum fall-down length in centimetres.
snapToCheapestAreastringSnap to the cheapest area under the endpoint (true/false).
descriptionstringFree-form description.
supportedAgentsarray of stringSupported agent names; empty preserves them.

Returns: actor, component, links, count, message.

Moves one simple link (world points), its direction and optional area.

ArgumentTypeDescription
actorstringrequired. NavLinkProxy actor label/name.
indexintegerSimple-link index. Default 0.
start{x,y,z}Link start in world centimetres.
end{x,y,z}Link end in world centimetres.
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.
enabledbooleanSmart link enabled state. Default true.

Returns: items, count, values, message.

Changes a NavModifierComponent's area, failsafe extent and agent-height expansion.

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringComponent name; empty selects the actor's only modifier component.
areaClassstringNavArea class path/name; empty preserves it ("None" clears a replacement area).
extent{x,y,z}Failsafe box half extent in centimetres (used when the owner has no collision); zero keeps it.
includeAgentHeightstringExpand the modifier bottom by the agent height (true/false); empty keeps it.

Returns: items, count, values, message.

Sets the area a NavModifierComponent replaces (UE 5.5+; areaClass None clears it).

ArgumentTypeDescription
actorstringrequired. Owner actor label/name.
componentNamestringComponent name; empty selects the actor's only modifier component.
areaClassstringNavArea class path/name; empty preserves it ("None" clears a replacement area).
extent{x,y,z}Failsafe box half extent in centimetres (used when the owner has no collision); zero keeps it.
includeAgentHeightstringExpand the modifier bottom by the agent height (true/false); empty keeps it.

Returns: items, count, values, message.

Sets the tile resolution a modifier forces (Low/Default/High/None): volumes need UE 5.2, components UE 5.3.

ArgumentTypeDescription
actorstringrequired. NavModifierVolume label, or the owner of a NavModifierComponent.
componentNamestringComponent name; empty edits a NavModifierVolume actor.
resolutionstringrequired. Low, Default, High or None.

Returns: modifiers, count.

Moves/resizes a NavModifierVolume and optionally changes its area.

ArgumentTypeDescription
namestringActor label/name for a new volume.
areaClassstringrequired. NavArea class path/name ("None" clears a replacement area).
location{x,y,z}Centre in centimetres.
extent{x,y,z}Positive brush half extents. Default FUeaVec3(500,500,250).
actorstringExisting actor reference for setters/components.

Returns: items, count, values, message.

Sets the area a NavModifierVolume replaces (UE 5.5+; areaClass None clears it).

ArgumentTypeDescription
namestringActor label/name for a new volume.
areaClassstringrequired. NavArea class path/name ("None" clears a replacement area).
location{x,y,z}Centre in centimetres.
extent{x,y,z}Positive brush half extents. Default FUeaVec3(500,500,250).
actorstringExisting actor reference for setters/components.

Returns: items, count, values, message.

Sets typed RecastNavMesh generation fields: tile, agent, cell (Default resolution), region/layer partitioning, filtering, simplification (text values; empty keeps the value). Rebuild afterwards.

ArgumentTypeDescription
actorstringRecastNavMesh actor label/name; empty selects the only one in the level.
cellSizestringCell size in centimetres (UE 5.2+: the Default resolution; use nav.set_resolution for Low/High).
cellHeightstringCell height in centimetres (UE 5.2+: the Default resolution).
tileSizeUUstringTile size in Unreal units.
agentRadiusstringAgent radius in centimetres.
agentHeightstringAgent height in centimetres.
agentMaxSlopestringMaximum walkable slope in degrees.
drawDebugstringWhether the nav mesh debug drawing is enabled.
minRegionAreastringMinimum region area in square centimetres.
mergeRegionSizestringRegions smaller than this are merged (square centimetres).
maxSimplificationErrorstringMaximum contour simplification error in cells.
regionPartitioningstringRegion partitioning: Monotone, Watershed or ChunkyMonotone.
layerPartitioningstringLayer partitioning: Monotone, Watershed or ChunkyMonotone.
regionChunkSplitsstringRegion chunk splits for ChunkyMonotone.
layerChunkSplitsstringLayer chunk splits for ChunkyMonotone.
performVoxelFilteringstringVoxel filtering (true/false).
markLowHeightAreasstringMark low-height areas (true/false).
filterLowSpanSequencesstringFilter low span sequences (true/false).
filterLowSpanFromTileCachestringFilter low spans from the tile cache (true/false).
sortNavigationAreasByCoststringSort navigation areas by cost (true/false).
generateNavLinksstringExperimental automatic nav link generation (true/false, UE 5.5+).

Returns: items, count, values, message.

Writes a batch of reflected Recast fields as one transactional navmesh edit.

ArgumentTypeDescription
propertiesarray of UeaKeyValuerequired. Property/value pairs on the navigation settings object.

Returns: items, count, values, message.

Adds or edits one area override of a Blueprint query filter (travel cost, entering cost, exclusion).

ArgumentTypeDescription
filterstringrequired. NavigationQueryFilter Blueprint asset path or unique name.
areaClassstringrequired. NavArea class path or name.
travelCoststringTravel cost override (> 0); "none" clears the override.
enteringCoststringEntering cost override (>= 0); "none" clears the override.
excludedstringExclude the area from paths (true/false).

Returns: filter, areas, includeFlags, excludeFlags, count, message.

Sets path query tuning of a RecastNavMesh (applies to the next queries, no rebuild needed).

ArgumentTypeDescription
navDatastringRecastNavMesh label/name; empty selects the only one.
maxSearchNodesstringDefault maximum A* search nodes (>= 1).
maxHierarchicalSearchNodesstringDefault maximum hierarchical search nodes (>= 1).
heuristicScalestringA* heuristic scale (>= 0; 0.999 keeps paths optimal).
verticalDeviationFromGroundCompensationstringVertical offset added to projected path points in centimetres.
useBetterOffsetsFromCornersstringOffset string-pulled corners away from walls (true/false).
allowNavLinkAsPathEndstringAllow a nav link as the path end (true/false).
useVirtualFiltersstringUse virtual query filters (true/false).

Returns: navData, maxSearchNodes, maxHierarchicalSearchNodes, heuristicScale, verticalDeviationFromGroundCompensation, useBetterOffsetsFromCorners, allowNavLinkAsPathEnd, useVirtualFilters, message.

Sets cell size, cell height and step height of one resolution (Low/High need UE 5.2; per-resolution step height needs UE 5.3). Rebuild afterwards.

ArgumentTypeDescription
navDatastringRecastNavMesh actor label/name; empty selects the only one.
resolutionstringLow, Default or High (UE 5.2+); before 5.2 only Default exists. Default TEXT("Default").
cellSizestringCell size in centimetres.
cellHeightstringCell height in centimetres.
agentMaxStepHeightstringMaximum step height in centimetres (per resolution from UE 5.3).

Returns: navData, perResolution, rows, message.

Sets the runtime generation mode (Static, Dynamic, DynamicModifiersOnly) of one navigation data actor; rebuild afterwards.

ArgumentTypeDescription
navDatastringNavigation data actor label/name; empty selects the only one.
modestringrequired. Static, Dynamic or DynamicModifiersOnly.

Returns: navData, count, message.

Sets RVO avoidance of a placed Character (use nav.set_agent_blueprint for Blueprint defaults).

ArgumentTypeDescription
actorstringrequired. Character actor label/name.
enabledbooleanrequired. Enable RVO avoidance.
radiusstringOptional non-negative consideration radius.
weightstringOptional avoidance weight from zero through one.

Returns: items, count, values, message.

Changes reflected project navigation settings and writes DefaultEngine.ini.

ArgumentTypeDescription
propertiesarray of UeaKeyValuerequired. Property/value pairs on the navigation settings object.

Returns: items, count, values, message.

Enables/disables the smart link of a proxy (and its navigation relevance).

ArgumentTypeDescription
actorstringrequired. NavLinkProxy actor label/name.
indexintegerSimple-link index. Default 0.
start{x,y,z}Link start in world centimetres.
end{x,y,z}Link end in world centimetres.
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.
enabledbooleanSmart link enabled state. Default true.

Returns: items, count, values, message.

Sets the NavArea used while the smart link is enabled and while it is disabled.

ArgumentTypeDescription
actorstringrequired. NavLinkProxy label/name.
enabledAreastringNavArea used while the smart link is enabled.
disabledAreastringNavArea used while the smart link is disabled.

Returns: links, count, message.

Configures the smart-link state broadcast that notifies nearby agents (radius, interval, on enable/disable).

ArgumentTypeDescription
actorstringrequired. NavLinkProxy label/name.
radiusstringBroadcast radius in centimetres (> 0 enables the broadcast).
intervalstringBroadcast interval in seconds (0 = only on state change).
notifyWhenEnabledstringNotify nearby agents when the link becomes enabled (true/false).
notifyWhenDisabledstringNotify nearby agents when the link becomes disabled (true/false).

Returns: links, count, message.

Adds a box obstacle (NavArea over a box) that the smart link applies while it is disabled.

ArgumentTypeDescription
actorstringrequired. NavLinkProxy label/name.
areaClassstringrequired. NavArea applied by the obstacle.
extent{x,y,z}Positive box half extent in centimetres. Default FUeaVec3(50.0, 50.0, 50.0).
offset{x,y,z}Box offset relative to the link in centimetres.

Returns: links, count, message.

Sets the smart-link endpoints (world points) and direction.

ArgumentTypeDescription
actorstringrequired. NavLinkProxy label/name.
start{x,y,z}required. Start in world centimetres.
end{x,y,z}required. End in world centimetres.
directionstringBothWays, LeftToRight or RightToLeft. Default TEXT("BothWays").

Returns: links, count, message.

Sets tile pool and generation job settings (fixed pool, pool size, hard limit, simultaneous jobs, empty layers, voxel cache, update interval).

ArgumentTypeDescription
navDatastringRecastNavMesh actor label/name; empty selects the only one.
fixedTilePoolSizestringUse a fixed-size tile pool (true/false).
tilePoolSizestringTile pool size when the pool is fixed.
tileNumberHardLimitstringAbsolute tile limit (power of two).
maxSimultaneousJobsstringMaximum simultaneous tile generation jobs (at least 1).
storeEmptyTileLayersstringKeep empty tile layers in the tile cache (true/false).
useVoxelCachestringCache voxel data between rebuilds (true/false).
tileSetUpdateIntervalstringSeconds between tile set updates for invoker-driven generation.

Returns: navData, fixedTilePoolSize, tilePoolSize, tileNumberHardLimit, maxSimultaneousJobs, storeEmptyTileLayers, useVoxelCache, tileSetUpdateInterval, tileSizeUU, tileCount, message.

Projects simple-link endpoints onto the navmesh (index -1 = every link).

ArgumentTypeDescription
actorstringrequired. NavLinkProxy actor label/name.
indexintegerSimple-link index. Default 0.
start{x,y,z}Link start in world centimetres.
end{x,y,z}Link end in world centimetres.
bidirectionalbooleanBoth-way traversal. Default true.
areaClassstringOptional NavArea class.
enabledbooleanSmart link enabled state. Default true.

Returns: items, count, values, message.

Spawns a pawn (default Character) possessed by an AIController (DetourCrowdAIController with crowd) in the PIE world. With ensureNavData the PIE navigation system also gets its default navigation data actor.

ArgumentTypeDescription
namestringLabel for the spawned pawn. Default TEXT("NavTestAgent").
controllerNamestringLabel for its AIController; empty uses name + "Controller".
location{x,y,z}Spawn location in centimetres (PIE world).
pawnClassstringPawn class path or name; empty spawns a plain Character.
controllerClassstringAIController class path or name; empty uses the pawn's own AIControllerClass (AIController for Character), or DetourCrowdAIController with crowd.
crowdbooleanUse a DetourCrowdAIController so the agent takes part in crowd avoidance (ignored when controllerClass is set). Default false.
ensureNavDatabooleanWhen the PIE world has no navigation data, create the default one so runtime queries have a target. Default true.

Returns: items, count, values, message.

Tests whether a complete path exists (same selectors as nav.find_path).

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: valid, partial, points, length, cost, navData, result, message.

Tests whether a path can be found to an actor's current location.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
goalActorstringrequired. Goal actor label or name.
tetherDistancenumberMoving-goal tether distance in centimetres. Default 50.0.

Returns: valid, partial, points, length, cost, navData, result, message.

Validates bounds, navigation data and simple links.

No arguments.

Returns: issues, count.

Validates one link proxy in depth: coincident or off-mesh endpoints, drops longer than maxFallDownLength, smart-link consistency.

ArgumentTypeDescription
actorstringrequired. Actor label or object name (must match exactly one actor).

Returns: issues, count.

Projects both endpoints before testing a path, exposing invalid endpoints separately.

ArgumentTypeDescription
start{x,y,z}required. Path start in centimetres.
end{x,y,z}required. Path end in centimetres.
navDatastringNavigation data actor label/name; empty uses the agent's data or the world's default navigation data.
agentstringSupported agent name (project navigation settings) whose navigation data is queried; empty uses navData or the default.
filterClassstringNavigationQueryFilter class path or name (e.g. a Blueprint filter); empty uses the navigation data's default filter.
allowPartialbooleanAccept partial paths that end at the closest reachable point. Default true.

Returns: items, count, values, message.

Waits off the game thread until the outstanding navigation build completes or times out.

ArgumentTypeDescription
maxFramesintegerMaximum editor frames to wait, from 1 through 100000. Default 600.

Returns: available, building, remainingTasks, boundsVolumes, navDataCount, autoUpdate, dirty, message.