PathEngine home previous: iMesh::loadConnectedRegionPreprocessFor()next: iMesh::loadPathfindPreprocessFor()
Contents, API Reference, Interfaces, iMesh, loadPath

iMesh::loadPath()

Description

Loads internal data relating to a path from persistent storage.

Syntax

iPath* loadPath(char const * data_Buffer, uint32_t data_BufferEntries) const;

Parameters

data_Buffer, data_BufferEntries (See Passing Arrays.) The data buffer to load from.

Requirements

The ground mesh and base circuits must be identical to the mesh on which the was originally generated.

Return Value

The loaded path.

Remarks

Use this method in conjunction with iMesh::savePath() to save and load paths to and from persistent storage.

The buffer passed in must contain data previously saved out by iMesh::savePath().

Note that an empty buffer can result from calling iMesh::savePath() with a null pointer.
loadPath() recognises this special case and returns a null pointer.

C# Mapping

Path loadPath(byte[] data);

Java Mapping

Path loadPath(byte[] data);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iMesh::loadPathfindPreprocessFor()