The A* Inspector

Brief overview of the various settings in the A* inspector.

The inspector of the AstarPath component has 5 sections.

  • Graphs: holds a list of all graphs in the scene

  • Settings: various pathfinding and editor settings

  • Save & Load: allows you to save and load graphs from files

  • Optimization: various optimizations that can be applied to the system using compiler directives

  • About: info about which version you have and some links to the documentation

There is also the 'Show Graphs' toggle which enables or disables the graphs from being rendered in the scene view, and lastly there is the 'Scan' button which recalculates all graphs. In the editor graphs are not scanned unless you press this button (or use the keyboard shortcut, see Keyboard Shortcuts).

Graphs

In the graphs tab you can see all graphs that are in the current scene. You may have multiple graphs and they are all stored in the AstarPath component (you do not create multiple AstarPath components). If you click on the 'Add New Graph' button you will see a list of all graph types that you can create.

Next to each graph there are 4 icons.

They are:

  • eye: Shows or hides the graph from being rendered in the scene view. When the graph is hidden this icon will turn red.

  • pen: Click on the pen to rename the graph. This can be very useful if you have many graphs and it is becoming hard to keep track of which one is which.

  • i: Clicking on the 'i' shows some information about how many nodes there are in the graph. Note that you must scan the graph for it to show anything relevant.

  • x: Clicking on the x will delete the graph.

Take a look at each graph's respective documentation for more info about their settings.

Settings

Pathfinding

Thread Count

Number of pathfinding threads to use.

Max Nearest Node Distance

Maximum distance to search for nodes.

Heuristic

The distance function to use as a heuristic.

Heuristic Scale

The scale of the heuristic.

Advanced

Heuristic Optimization

If heuristic optimization should be used and how to place the pivot points.

Batch Graph Updates

Throttle graph updates and batch them to improve performance.

Update Interval

Minimum number of seconds between each batch of graph updates.

Prioritize Graphs

Prioritize graphs.

Priority Limit

Distance limit for prioritizeGraphs.

Full Get Nearest Node Search

Do a full GetNearest search for all graphs.

Scan on Awake

If true, all graphs will be scanned during Awake.

Debug

Path Logging

The amount of debugging messages.

Graph Coloring

The mode to use for drawing nodes in the sceneview.

Show Search Tree

If enabled, nodes will draw a line to their 'parent'.

Show Unwalkable Nodes

Toggle to show unwalkable nodes.

Colors

Here you can set the colors to be used in the scene view to visualize the graphs.

Tag Names

Here you can set the names of all tags.

Editor

Smooth Transitions

Animate dropdowns when they open and close.

Save & Load

In this section you can both save the graphs to files which you can later load, or you can configure cached startup: a way to avoid the sometimes long calculation time at the start of the game when the graph is being calculated.

See

Take a look at this page for more information: Saving and Loading Graphs

Optimization

Compiler directives are a way to tell the compiler to exclude or include some parts of the code in the compilation. This allows for very drastic changes like removing or adding fields to a class or changing what a method does with no runtime overhead at all. This package has a few different options which can for example disable certain features to reduce the memory usage or improve the performance of the package.

See

Take a look at this page for more information: Compiler Directives

About

This section shows the current version and links to the documentation.

Note

This always links to the latest non-beta documentation, however you can find the documentation for older versions or beta releases by clicking on the 'Show Older Versions' button on the download page: https://www.arongranberg.com/astar/download

Show Graphs

Show Graphs

Visualize graphs in the scene view (editor only).