Difference between revisions of "ISInterface:NavigationGetNearestPoint"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
===Syntax=== | ===Syntax=== | ||
| − | + | *bool NavigationGetNearestPoint(char *World, POINT3F &To, POINT3F &Dest) | |
== Purpose == | == Purpose == | ||
| − | + | To get the nearest point to a given POINT3F coordinate in a world | |
== Usage == | == Usage == | ||
=== Parameters === | === Parameters === | ||
| − | + | *char *World | |
| + | :'''[in]''' Name of the world to use | ||
| + | *POINT3F &To | ||
| + | :'''[in]''' What POINT3F to find the nearest point to | ||
| + | *POINT3F &Dest | ||
| + | :'''[out]''' POINT3F variable to put the nearest point into | ||
=== Return Value === | === Return Value === | ||
| − | + | *bool | |
| + | :Returns true on success, false on failure | ||
== Examples == | == Examples == | ||
| − | + | POINT3F CurrentPoint,ClosestPoint; | |
| + | NavigationGetNearestPoint("Earth",CurrentPoint,ClosestPoint); | ||
== See Also == | == See Also == | ||
Latest revision as of 03:18, 3 September 2005
Syntax
- bool NavigationGetNearestPoint(char *World, POINT3F &To, POINT3F &Dest)
Purpose
To get the nearest point to a given POINT3F coordinate in a world
Usage
Parameters
- char *World
- [in] Name of the world to use
- POINT3F &To
- [in] What POINT3F to find the nearest point to
- POINT3F &Dest
- [out] POINT3F variable to put the nearest point into
Return Value
- bool
- Returns true on success, false on failure
Examples
POINT3F CurrentPoint,ClosestPoint;
NavigationGetNearestPoint("Earth",CurrentPoint,ClosestPoint);
