Interface CrowdAgent

An active crowd agent returned by RecastModule.crowdGetActiveAgents.

interface CrowdAgent {
    idx: number;
    position: Vec3;
    velocity: Vec3;
    radius: number;
    active: boolean;
    state: number;
    neighbors: number;
    partial: boolean;
    desiredSpeed: number;
}

Properties

idx: number

Agent index in the crowd.

position: Vec3

Agent position

velocity: Vec3

Agent velocity

radius: number

Agent radius

active: boolean

True if the agent is active, false if the agent is in an unused slot in the agent pool.

state: number

The type of mesh polygon the agent is traversing.

neighbors: number

Number of neighbouring agents.

partial: boolean

true if the agent could only find a partial path to the target.

desiredSpeed: number

Agent desired speed.