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

Initializes a sliced path find query.

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 InitSlicedFindPath(
	NavmeshPoint start,
	NavmeshPoint end,
	NavmeshQueryFilter filter
)
Public Function InitSlicedFindPath ( _
	start As NavmeshPoint, _
	end As NavmeshPoint, _
	filter As NavmeshQueryFilter _
) As NavStatus
public:
NavStatus InitSlicedFindPath(
	NavmeshPoint start, 
	NavmeshPoint end, 
	NavmeshQueryFilter^ filter
)

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.

Return Value

The NavStatus flags for the query.

Remarks

This method will fail if IsRestricted is true.

Warning: Calling any other query methods besides the other sliced path methods before finalizing this query may result in corrupted data.

The filter is stored and used for the duration of the query.

The standard use case:

  1. Initialize the sliced path query
  2. Call UpdateSlicedFindPath(Int32, Int32%) until its status returns complete.
  3. Call FinalizeSlicedFindPath(array<UInt32>[]()[][], Int32%) to get the path.

See Also