API

Interface IAgentParameters

Configures an agent

interface IAgentParameters {
    collisionQueryRange: number;
    height: number;
    maxAcceleration: number;
    maxSpeed: number;
    pathOptimizationRange: number;
    radius: number;
    reachRadius?: number;
    separationWeight: number;
}
Index
collisionQueryRange: number

Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]

height: number

Agent height. [Limit: > 0]

maxAcceleration: number

Maximum allowed acceleration. [Limit: >= 0]

maxSpeed: number

Maximum allowed speed. [Limit: >= 0]

pathOptimizationRange: number

The path visibility optimization range. [Limit: > 0]

radius: number

Agent radius. [Limit: >= 0]

reachRadius?: number

Observers will be notified when agent gets inside the virtual circle with this Radius around destination point. Default is agent radius

separationWeight: number

How aggressive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]