getTraverseCost

next: iAgent::getTraverseCostDirection()

Contents, API Reference, Interfaces, iAgent, getTraverseCost

iAgent::getTraverseCost()

Description

A helper function which can be used to determine whether an agent is set to behave as a 'soft obstacle', and the traverse cost associated with the agent.

Syntax

float getTraverseCost() const;

Return Value

If the agent has been set to behave as a soft obstacle then the traverse cost for the agent will be returned (which will be a value >=0.f).
Otherwise -1.f is returned, to indicate that the agent is a traditional 'hard obstacle'.

C# Mapping

float getTraverseCost();

Java Mapping

float getTraverseCost();