PathEngine home previous: iConnectionTestCallBack::testDropCandidatePair()next: Interface iTestBed
Contents, API Reference, Interfaces, iConnectionTestCallBack, testJumpCandidatePair

iConnectionTestCallBack::testJumpCandidatePair()

Description

PathEngine calls back to this method for application-side validation of jump type connection candidates.

Syntax

void testJumpCandidatePair(int32_t fromX, int32_t fromY, int32_t fromZ, int32_t toX, int32_t toY, int32_t toZ, int32_t& penaltyOut, int32_t& penaltyBack);

Parameters

fromX X coordinate of the connection candidate from point.
fromY Y coordinate of the connection candidate from point.
fromZ Z coordinate (height) of the connection candidate from point.
toX X coordinate of the connection candidate to point.
toY Y coordinate of the connection candidate to point.
toZ Z coordinate (height) of the connection candidate to point.
penaltyOut The cost of off-mesh movement from the 'from' endpoint candidate to the 'to' endpoint candidate, or -1 if off mesh movement is not possible between these endpoint candidates and in this direction.
penaltyBack The cost of off-mesh movement from the 'to' endpoint candidate to the 'from' endpoint candidate, or -1 if off mesh movement is not possible between these endpoint candidates and in this direction.

C# Mapping

void testJumpCandidatePair(int fromX, int fromY, int fromZ, int toX, int toY, int toZ, out int penaltyOut, out int penaltyBack);

Java Mapping

void testJumpCandidatePair(int fromX, int fromY, int fromZ, int toX, int toY, int toZ, int_OutArgument penaltyOut, int_OutArgument penaltyBack);

Documentation for PathEngine release 6.04 - Copyright © 2002-2024 PathEnginenext: Interface iTestBed