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

Gets the endpoints for an off-mesh connection, ordered by 'direction of travel'.

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 GetConnectionEndpoints(
	uint startPolyRef,
	uint connectionPolyRef,
	out Vector3 startPoint,
	out Vector3 endPoint
)
Public Function GetConnectionEndpoints ( _
	startPolyRef As UInteger, _
	connectionPolyRef As UInteger, _
	<OutAttribute> ByRef startPoint As Vector3, _
	<OutAttribute> ByRef endPoint As Vector3 _
) As NavStatus
public:
NavStatus GetConnectionEndpoints(
	unsigned int startPolyRef, 
	unsigned int connectionPolyRef, 
	[OutAttribute] Vector3% startPoint, 
	[OutAttribute] Vector3% endPoint
)

Parameters

startPolyRef
UInt32
The reference of the polygon that contains the start point.
connectionPolyRef
UInt32
The off-mesh connection's reference.
startPoint
Vector3%
The start point. (Out)
endPoint
Vector3%
The end point. (Out)

Return Value

The NavStatus flags for the operation.

Remarks

Off-mesh connections are stored in the navigation mesh as special 2-vertex polygons with a single edge. At least one of the vertices is expected to be inside a normal polygon. So an off-mesh connection is "entered" from a normal polygon at one of its endpoints. This is the polygon identified by startPolyRef.

See Also