[This is preliminary documentation and is subject to change.]

Finds the polygon path from the start to the end polygon.

Namespace: org.critterai.nav
Assembly: cai-nav (in cai-nav.dll) Version: 0.4.0.0 (0.4.0.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public NavStatus FindPath(
	NavmeshPoint start,
	NavmeshPoint end,
	NavmeshQueryFilter filter,
	uint[] resultPath,
	out int pathCount
)
Public Function FindPath ( _
	start As NavmeshPoint, _
	end As NavmeshPoint, _
	filter As NavmeshQueryFilter, _
	resultPath As UInteger(), _
	<OutAttribute> ByRef pathCount As Integer _
) As NavStatus
public:
NavStatus FindPath(
	NavmeshPoint start, 
	NavmeshPoint end, 
	NavmeshQueryFilter^ filter, 
	array<unsigned int>^ resultPath, 
	[OutAttribute] int% pathCount
)

Parameters

start
NavmeshPoint
A point within the start polygon.
end
NavmeshPoint
A point within the end polygon.
filter
NavmeshQueryFilter
The filter to apply to the query.
resultPath
array<UInt32>[]()[][]
An ordered list of polygoon references in the path. (Start to end.) (Out) [(polyRef) * pathCount]
pathCount
Int32%
The number of polygons in the path.

Return Value

The NavStatus flags for the query.

Remarks

If the end polygon cannot be reached, then the last polygon is the nearest one found to the end polygon.

If the path buffer is to small to hold the result, it will be filled as far as possible from the start polygon toward the end polygon.

The start and end points are used to calculate traversal costs. (y-values matter.)

See Also