/tg/ Station 13 - Modules - Types — Var Details - Proc Details

navmap

Navmap pathfinding, has DLL and a DM fallback support

Vars

action_pathActions associated with each path tile (used for nav links).
allow_multizWhether paths may cross z-levels.
allow_nav_linksWhether the search may traverse registered navigation links.
allow_tick_yieldWhether search steps may yield to the tick.
completeWhether pathfinding has finished.
diagonal_handlingHow diagonal steps should be handled.
endThe target turf for the path.
force_dmWhether to force the DM implementation.
job_idThe active native pathfinding job.
max_path_costThe maximum total path cost.
minimum_distanceThe minimum distance from the target.
nav_cost_generationSnapshot of turf cost data when this search began.
nav_cost_heuristic_scaleConservative heuristic scale for discounted terrain modifiers.
nav_cost_modifiersPer-search flag-to-multiplier map used by both native and DM searches.
nav_cost_modifiers_nativeFlat flag/multiplier values passed through the DLL
nav_cost_staleSet when a relevant changed cost turf has already contributed to this DM search.
navmap_astar_actionAction associated with each visited turf.
navmap_astar_closedNodes already processed by A*.
navmap_astar_cost_flags_usedEffective cost flags used by turfs already considered by this search.
navmap_astar_cost_multiplier_cacheCached combined multipliers indexed by the turf's numeric flag combination.
navmap_astar_diagonal_intermediateCardinal intermediate selected when an expanded diagonal was priced.
navmap_astar_edge_cacheCached cardinal edge results.
navmap_astar_f_scoreEstimated total costs for nodes.
navmap_astar_g_scoreCurrent movement costs for nodes.
navmap_astar_heap_indexHeap positions for open nodes.
navmap_astar_heuristic_cacheCached relaxed lower-bound estimates for multi-z A*.
navmap_astar_is_flyingWhether the mover uses flying navigation.
navmap_astar_min_link_costCheapest registered nav link, used as a constant admissible cross-z lower bound.
navmap_astar_openOpen nodes in the DM A* heap.
navmap_astar_parentParent node for each visited turf.
navmap_astar_simulated_cacheCached simulated-turf results.
navmap_pass_flagsConditional pass flags captured when the search starts.
navmap_topology_generationTopology generation captured for searches that may traverse links or z-levels.
pathThe resulting turf path.
requesterThe mover requesting the path.
skip_firstWhether to omit the first path tile.
use_nativeWhether the native implementation is active.

Procs

DestroyReleases navmap search state.
early_exitCancels an active native search before exiting.
finishedDelivers the completed path to the requester.
handle_resultApplies a native pathfinding result to this search.
nav_cost_flags_changedMarks a fallback search stale when a modifier group changed on a turf it already used.
navmap_astar_build_pathExpands diagonal steps and records path actions.
navmap_astar_diagonal_routesReturns bit 1 for north/south-first and bit 2 for east/west-first routes.
navmap_astar_heap_popRemoves the best node from the A* heap.
navmap_astar_heap_sift_downMoves a node downward in the A* heap.
navmap_astar_heap_sift_upMoves a node upward in the A* heap.
navmap_astar_heuristicEstimates the remaining cost to the target.
navmap_astar_initializeInitializes the DM A* search state.
navmap_astar_queue_updateAdds or reprioritizes a node in the A* heap.
navmap_astar_reconstructRebuilds a path by following parent nodes.
navmap_astar_relaxed_distanceReturns a relaxed geometric cost between two turfs, or null for disconnected layers.
navmap_astar_resolve_edgesResolves and caches horizontal edges from a turf.
navmap_astar_resolve_vertical_edgesResolves and caches vertical edges from a turf.
navmap_astar_route_openChecks whether a two-cardinal route is open.
navmap_astar_search_stepPerforms one DM A* search step.
navmap_astar_step_costApplies matching turf modifiers to a base movement cost.
navmap_astar_turf_occupiableChecks the cheap occupancy constraints without resolving the candidate's outgoing edges. Incoming cardinal/diagonal edges already vlidate the destination's passability; the full edge set is resolved when the candidate is popped and expanded.
navmap_astar_turf_openChecks whether a turf can be searched.
navmap_astar_vertical_openChecks whether a vertical edge can be traversed.
search_stepAdvances the active pathfinding search.
setupConfigures a navmap search from a requester and access list.
setup_with_pass_infoConfigures a navmap search with prepared pass information.
startStarts native or DM navmap pathfinding.

Var Details

action_path

Actions associated with each path tile (used for nav links).

allow_multiz

Whether paths may cross z-levels.

Whether the search may traverse registered navigation links.

allow_tick_yield

Whether search steps may yield to the tick.

complete

Whether pathfinding has finished.

diagonal_handling

How diagonal steps should be handled.

end

The target turf for the path.

force_dm

Whether to force the DM implementation.

job_id

The active native pathfinding job.

max_path_cost

The maximum total path cost.

minimum_distance

The minimum distance from the target.

nav_cost_generation

Snapshot of turf cost data when this search began.

nav_cost_heuristic_scale

Conservative heuristic scale for discounted terrain modifiers.

nav_cost_modifiers

Per-search flag-to-multiplier map used by both native and DM searches.

nav_cost_modifiers_native

Flat flag/multiplier values passed through the DLL

nav_cost_stale

Set when a relevant changed cost turf has already contributed to this DM search.

navmap_astar_action

Action associated with each visited turf.

navmap_astar_closed

Nodes already processed by A*.

navmap_astar_cost_flags_used

Effective cost flags used by turfs already considered by this search.

navmap_astar_cost_multiplier_cache

Cached combined multipliers indexed by the turf's numeric flag combination.

navmap_astar_diagonal_intermediate

Cardinal intermediate selected when an expanded diagonal was priced.

navmap_astar_edge_cache

Cached cardinal edge results.

navmap_astar_f_score

Estimated total costs for nodes.

navmap_astar_g_score

Current movement costs for nodes.

navmap_astar_heap_index

Heap positions for open nodes.

navmap_astar_heuristic_cache

Cached relaxed lower-bound estimates for multi-z A*.

navmap_astar_is_flying

Whether the mover uses flying navigation.

Cheapest registered nav link, used as a constant admissible cross-z lower bound.

navmap_astar_open

Open nodes in the DM A* heap.

navmap_astar_parent

Parent node for each visited turf.

navmap_astar_simulated_cache

Cached simulated-turf results.

navmap_pass_flags

Conditional pass flags captured when the search starts.

navmap_topology_generation

Topology generation captured for searches that may traverse links or z-levels.

path

The resulting turf path.

requester

The mover requesting the path.

skip_first

Whether to omit the first path tile.

use_native

Whether the native implementation is active.

Proc Details

Destroy

Releases navmap search state.

early_exit

Cancels an active native search before exiting.

finished

Delivers the completed path to the requester.

handle_result

Applies a native pathfinding result to this search.

nav_cost_flags_changed

Marks a fallback search stale when a modifier group changed on a turf it already used.

navmap_astar_build_path

Expands diagonal steps and records path actions.

navmap_astar_diagonal_routes

Returns bit 1 for north/south-first and bit 2 for east/west-first routes.

navmap_astar_heap_pop

Removes the best node from the A* heap.

navmap_astar_heap_sift_down

Moves a node downward in the A* heap.

navmap_astar_heap_sift_up

Moves a node upward in the A* heap.

navmap_astar_heuristic

Estimates the remaining cost to the target.

navmap_astar_initialize

Initializes the DM A* search state.

navmap_astar_queue_update

Adds or reprioritizes a node in the A* heap.

navmap_astar_reconstruct

Rebuilds a path by following parent nodes.

navmap_astar_relaxed_distance

Returns a relaxed geometric cost between two turfs, or null for disconnected layers.

navmap_astar_resolve_edges

Resolves and caches horizontal edges from a turf.

navmap_astar_resolve_vertical_edges

Resolves and caches vertical edges from a turf.

navmap_astar_route_open

Checks whether a two-cardinal route is open.

navmap_astar_search_step

Performs one DM A* search step.

navmap_astar_step_cost

Applies matching turf modifiers to a base movement cost.

navmap_astar_turf_occupiable

Checks the cheap occupancy constraints without resolving the candidate's outgoing edges. Incoming cardinal/diagonal edges already vlidate the destination's passability; the full edge set is resolved when the candidate is popped and expanded.

navmap_astar_turf_open

Checks whether a turf can be searched.

navmap_astar_vertical_open

Checks whether a vertical edge can be traversed.

search_step

Advances the active pathfinding search.

setup

Configures a navmap search from a requester and access list.

setup_with_pass_info

Configures a navmap search with prepared pass information.

start

Starts native or DM navmap pathfinding.