[This is preliminary documentation and is subject to change.]
Assembly: cai-nav (in cai-nav.dll) Version: 0.4.0.0 (0.4.0.0)
|C#||Visual Basic||Visual C++|
The desired position.
Return ValueThe result of the move.
- The movement is constrained to the surface of the navigation mesh.
- The corridor is automatically adjusted (shorted or lengthened) and Corners updated in order to remain valid.
- The new position will be located in the adjusted corridor's first polygon.
The expected use case: The desired position will be 'near' the corridor. What is considered 'near' depends on local polygon density, query search extents, etc.
The resulting position will differ from the desired position if the desired position is not on the navigation mesh, or it can't be reached using a local search.