Difference between revisions of "ISInterface:NavigationGetPath"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool NavigationGetPath(char *World, char *From, char *To, CNavPath &Dest) | |
== Purpose == | == Purpose == | ||
| − | + | Get a path in a world from point A to point B | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| − | + | *char *World | |
| + | :'''[in]''' Name of the world the points are in | ||
| + | *char *From | ||
| + | :'''[in]''' Point A in the world | ||
| + | *char *To | ||
| + | :'''[in]''' Point B in the world | ||
| + | *CNavPath &Dest | ||
| + | :'''[out]''' CNavPath the path in the world will be put into | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | CNavPath CurrentPath; | |
| + | pISInterface->NavigationGetPath("Earth","Earth_Start","Earth_End",CurrentPath); | ||
== See Also == | == See Also == | ||
Latest revision as of 03:10, 3 September 2005
Syntax
- bool NavigationGetPath(char *World, char *From, char *To, CNavPath &Dest)
Purpose
Get a path in a world from point A to point B
Usage
Parameters
- char *World
- [in] Name of the world the points are in
- char *From
- [in] Point A in the world
- char *To
- [in] Point B in the world
- CNavPath &Dest
- [out] CNavPath the path in the world will be put into
Return Value
- bool
- Returns true on success, false on failure
Examples
CNavPath CurrentPath;
pISInterface->NavigationGetPath("Earth","Earth_Start","Earth_End",CurrentPath);
