PathEngine home previous: iAgent::canCollide()next: iAgent::findClosestUnobstructedPosition()
Contents, API Reference, Interfaces, iAgent, canPathfind

iAgent::canPathfind()

Description

A helper function to determine whether pathfinding queries can be made for the agent.

Syntax

bool canPathfind(const iCollisionContext* context) const;

Parameters

context The collision context that will be used for pathfinding. Can be set to zero if no context will be used (as for the pathfinding queries themselves).

Return Value

Returns true, if the agent is moveable and pathfinding queries are supported on the agent's mesh for the agent's shape and with the supplied collision context. Otherwise returns false.

Remarks

For non-moveable agents, this method returns false.

Otherwise, this method essentially just calls on to iMesh::shapeCanPathfind() for the agents mesh and shape.

C# Mapping

bool canPathfind(CollisionContext context);

Java Mapping

boolean canPathfind(CollisionContext context);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iAgent::findClosestUnobstructedPosition()