PathEngine home previous: iAgent::setTraverseCostDirection()next: iAgent::testCollisionAt()
Contents, API Reference, Interfaces, iAgent, setUserData

iAgent::setUserData()

Description

Enables the client application to associate arbitrary application data with an agent.

Syntax

void setUserData(void* voidPointer);

Parameters

voidPointer A void pointer to associate with the agent.

Remarks

The user data is initialised to zero (null pointer).

Note that the client application will be responsable for ensuring that this data remains valid after save and load from persistence.

The value can be later retrieved with iAgent::getUserData().


Documentation for PathEngine release 5.17 - Copyright © 2002-2008 PathEnginenext: iAgent::testCollisionAt()