getOverlayConnectionPenalty

previous: iCollisionContext::getObstacleSet()

next: iCollisionContext::hasOverlayConnectionPenalties()

Contents, API Reference, Interfaces, iCollisionContext, getOverlayConnectionPenalty

iCollisionContext::getOverlayConnectionPenalty()

Description

Helper method for querying the value of overlay connection penalties set previously for this context (with iCollisionContext::setOverlayConnectionPenalty()).

Syntax

tSigned32 getOverlayConnectionPenalty(tSigned32 connectionIndex) const;

Parameters

connectionIndex

The index for the connection to be queried.
(Must be non-negative and less than the number of off-mesh connections on the mesh for which this context was created.)

Return Value

The current overlay penalty for the specified connection, if any, or otherwise the base penalty for the connection.

next: iCollisionContext::hasOverlayConnectionPenalties()