[This is preliminary documentation and is subject to change.]

Represents an agent managed by a CrowdManager object.

Namespace: org.critterai.nav
Assembly: cai-nav (in cai-nav.dll) Version: 0.4.0.0 (0.4.0.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public sealed class CrowdAgent
Public NotInheritable Class CrowdAgent
public ref class CrowdAgent sealed

Members

         
 All Members  Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
AdjustMoveTarget(NavmeshPoint)
Adjusts the position of an agent's target.
DesiredSpeed
The desired agent speed. (Derived)
DesiredVelocity
The desired agent velocity. (Derived)
GetBoundary(LocalBoundaryData)
Gets the local boundary data for the agent.
GetConfig()()()()
Gets the agent configuration.
GetCornerData(CornerData)
Gets the local corner data for the agent.
GetCorridor(PathCorridorData)
Gets the corridor data related to the agent.
GetNeighbor(CrowdNeighbor)
Gets the agent associated with the specified neighbor.
GetNeighbors(array<CrowdNeighbor>[]()[][])
Gets data related to the neighbors in the vicinity of the agent.
IsDisposed
Indicates whether the object's resources have been disposed.
Manager
The CrowdManager the agent belongs to.
NeighborCount
The number of neighbor agents. (In vicinity of agent.)
NextCorner
The next corner in the path corridor.
NextCornerPoly
The reference of the polygon containing the next corner.
Position
The position of the agent.
PositionPoly
The reference of the polygon containing the agent position.
RequestMoveTarget(NavmeshPoint)
Submits a new move request for the agent.
SetConfig(CrowdAgentParams)
Updates the configuration for an agent.
State
The type of mesh polygon the agent is traversing.
Target
The agent's target. (Location the agent is moving toward.)
TargetPoly
The reference of the polygon containing the target.
Velocity
The actual agent velocity.

Remarks

Objects of this type can only be obtained from a CrowdManager object.

Behavior is undefined if used after disposal. Disposal is controled by the CrowdManager that owns the agent.

Inheritance Hierarchy

System..::..Object
  org.critterai.nav..::..CrowdAgent

See Also