Class AstarData

NavGraph AddGraph (

System.Type

type

)

Adds a graph of type type to the graphs array.

void Awake ()

Loads the graphs from memory, will load cached graphs if any exists.

void DeserializeGraphs ()

Deserializes graphs from data.

void DeserializeGraphs (

byte []

bytes

)

Deserializes graphs from the specified byte array.

An error will be logged if deserialization fails.

void DeserializeGraphsAdditive (

byte []

bytes

)

Deserializes graphs from the specified byte array additively.

An error will be logged if deserialization fails. This function will add loaded graphs to the current ones.

NavGraph FindGraph (

System.Func<NavGraph, bool>

predicate

)

Returns the first graph which satisfies the predicate.

Returns null if no graph was found.

NavGraph FindGraphOfType (

System.Type

type

)

Returns the first graph of type type found in the graphs array.

Returns null if no graph was found.

IEnumerable FindGraphsOfType (

System.Type

type

)

Loop through this function to get all graphs of type 'type'.

foreach (GridGraph graph in AstarPath.data.FindGraphsOfType (typeof(GridGraph))) {
//Do something with the graph
}


void FindGraphTypes ()

Find all graph types supported in this build.

Using reflection, the assembly is searched for types which inherit from NavGraph.

NavGraph FindGraphWhichInheritsFrom (

System.Type

type

)

Returns the first graph which inherits from the type type.

Returns null if no graph was found.

byte [] GetData ()

int GetGraphIndex (

NavGraph

graph

)

Gets the index of the NavGraph in the graphs array.

void GetNodes (

System.Action<GraphNode>

callback

)

Calls the callback with every node in all graphs.

This is the easiest way to iterate through every existing node.

AstarPath.active.data.GetNodes(node => {
Debug.Log("I found a node at position " + (Vector3)node.position);
});


IEnumerable GetUpdateableGraphs ()

All graphs which implements the UpdateableGraph interface.

foreach (IUpdatableGraph graph in AstarPath.data.GetUpdateableGraphs ()) {
//Do something with the graph
}


void LoadFromCache ()

Load from data from file_cachedStartup.

void OnDestroy ()

bool RemoveGraph (

NavGraph

graph

)

Removes the specified graph from the graphs array and Destroys it in a safe manner.

To avoid changing graph indices for the other graphs, the graph is simply nulled in the array instead of actually removing it from the array. The empty position will be reused if a new graph is added.

byte [] SerializeGraphs ()

Serializes all graphs settings to a byte array.

byte [] SerializeGraphs (

Pathfinding.Serialization.SerializeSettings

settings

)

Serializes all graphs settings and optionally node data to a byte array.

byte [] SerializeGraphs (

Pathfinding.Serialization.SerializeSettings	settings
out uint	checksum

)

Main serializer function.

Serializes all graphs to a byte array A similar function exists in the AstarPathEditor.cs script to save additional info

void SetData (

byte []

data

)

void UpdateShortcuts ()

Updates shortcuts to the first graph of different types.

Hard coding references to some graph types is not really a good thing imo. I want to keep it dynamic and flexible. But these references ease the use of the system, so I decided to keep them.

NavGraph GetGraph (

GraphNode

node

)

Returns the graph which contains the specified node.

The graph must be in the graphs array.

bool cacheStartup

Should graph-data be cached.

Caching the startup means saving the whole graphs - not only the settings - to a file (file_cachedStartup) which can be loaded when the game starts. This is usually much faster than scanning the graphs when the game starts. This is configured from the editor under the "Save & Load" tab.

TextAsset file_cachedStartup

Serialized data for cached startup.

If set, on start the graphs will be deserialized from this file.

NavGraph[] graphs = new NavGraph[0]

All graphs this instance holds.

This will be filled only after deserialization has completed. May contain null entries if graph have been removed.

System.Type [] graphTypes

All supported graph types.

Populated through reflection search

GridGraph gridGraph

Shortcut to the first GridGraph.

Updated at scanning time

LayerGridGraph layerGridGraph

Shortcut to the first LayerGridGraph.

Updated at scanning time.

NavMeshGraph navmesh

Shortcut to the first NavMeshGraph.

Updated at scanning time

PointGraph pointGraph

Shortcut to the first PointGraph.

Updated at scanning time

RecastGraph recastGraph

Shortcut to the first RecastGraph.

Updated at scanning time.

AstarPath active

Shortcut to AstarPath.active.

void AddGraph (

NavGraph

graph

)

Adds the specified graph to the graphs array.

PathProcessor.GraphUpdateLock AssertSafe (

bool

onlyAddingGraph=false

)

void ClearGraphs ()

Destroys all graphs and sets graphs to null.

NavGraph CreateGraph (

System.Type

type

)

Creates a new graph instance of type type.

byte [] data

Serialized data for all graphs and settings.

string dataString

Serialized data for all graphs and settings.

Stored as a base64 encoded string because otherwise Unity's Undo system would sometimes corrupt the byte data (because it only stores deltas).

This can be accessed as a byte array from the data property.

void DeserializeGraphsPartAdditive (

Pathfinding.Serialization.AstarSerializer

sr

)

Helper function for deserializing graphs.

List<bool> graphStructureLocked = new List<bool>()

void LockGraphStructure (

bool

allowAddingGraphs=false

)

Prevent the graph structure from changing during the time this lock is held.

This prevents graphs from being added or removed and also prevents graphs from being serialized or deserialized. This is used when e.g an async scan is happening to ensure that for example a graph that is being scanned is not destroyed.

Each call to this method *must* be paired with exactly one call to UnlockGraphStructure. The calls may be nested.

void UnlockGraphStructure ()

Allows the graph structure to change again.

byte [] upgradeData

Data from versions from before 3.6.1.

Used for handling upgrades

NavGraph AddGraph (

string

type

)

Adds a graph of type type to the graphs array.

NavGraph CreateGraph (

string

type

)

Creates a new instance of a graph of type type.

If no matching graph type was found, an error is logged and null is returned

byte [] data_cachedStartup

Serialized data for cached startup.

System.Type GetGraphType (

string

type

)

IEnumerable GetRaycastableGraphs ()

All graphs which implements the UpdateableGraph interface.

foreach (IRaycastableGraph graph in AstarPath.data.GetRaycastableGraphs ()) {
//Do something with the graph
}