Class CrowdAgent

constructor

• new CrowdAgent(crowd, agentIndex): CrowdAgent

• Parameters

  • crowd: Crowd

  • agentIndex: number

  Returns CrowdAgent

agentIndex

crowd

interpolatedPosition

raw

collisionQueryRange

• get collisionQueryRange(): number

• Returns number

• set collisionQueryRange(value): void

• Parameters

  • value: number

  Returns void

height

• get height(): number

• Returns number

• set height(value): void

• Parameters

  • value: number

  Returns void

maxAcceleration

• get maxAcceleration(): number

• Returns number

• set maxAcceleration(value): void

• Parameters

  • value: number

  Returns void

maxSpeed

• get maxSpeed(): number

• Returns number

• set maxSpeed(value): void

• Parameters

  • value: number

  Returns void

obstacleAvoidanceType

• get obstacleAvoidanceType(): number

• Returns number

• set obstacleAvoidanceType(value): void

• Parameters

  • value: number

  Returns void

pathOptimizationRange

• get pathOptimizationRange(): number

• Returns number

• set pathOptimizationRange(value): void

• Parameters

  • value: number

  Returns void

queryFilterType

• get queryFilterType(): number

• Returns number

• set queryFilterType(value): void

• Parameters

  • value: number

  Returns void

radius

• get radius(): number

• Returns number

• set radius(value): void

• Parameters

  • value: number

  Returns void

separationWeight

• get separationWeight(): number

• Returns number

• set separationWeight(value): void

• Parameters

  • value: number

  Returns void

updateFlags

• get updateFlags(): number

• Returns number

• set updateFlags(value): void

• Parameters

  • value: number

  Returns void

userData

• get userData(): unknown

• Returns unknown

• set userData(value): void

• Parameters

  • value: unknown

  Returns void

corners

• corners(): Vector3[]

• Returns the local path corridor corners for the agent

  Returns Vector3[]

desiredVelocity

• desiredVelocity(): Vector3

• The desired velocity of the agent. Based on the current path, calculated from scratch each frame.

  Returns Vector3

desiredVelocityObstacleAdjusted

• desiredVelocityObstacleAdjusted(): Vector3

• The desired velocity adjusted by obstacle avoidance, calculated from scratch each frame.

  Returns Vector3

nextTargetInPath

• nextTargetInPath(): Vector3

• Returns the next target position on the path to the target

  Returns Vector3

overOffMeshConnection

• overOffMeshConnection(): boolean

• Returns whether the agent is over an off-mesh connection.

  Returns boolean

parameters

• parameters(): CrowdAgentParams

• Returns the agents parameters.

  Returns CrowdAgentParams

position

• position(): Vector3

• The position of the agent.

  Returns Vector3

requestMoveTarget

• requestMoveTarget(position): boolean

• Updates the agent's target.

  Parameters

  • position: Vector3

    The new target position.

  Returns boolean

  True if the request was successful.

requestMoveVelocity

• requestMoveVelocity(velocity): boolean

• Submits a new move request for the specified agent.

  Parameters

  • velocity: Vector3

    The desired velocity of the agent.

  Returns boolean

  True if the request was successful.

resetMoveTarget

• resetMoveTarget(): void

• Resets the current move request for the specified agent.

  Returns void

setParameters

• setParameters(crowdAgentParams): void

• Sets the agent's parameters. Any parameters not specified in the crowdAgentParams object will be set to their default values.

  Parameters

  • crowdAgentParams: Partial<CrowdAgentParams>

    agent parameters

  Returns void

state

• state(): number

• Returns the state of the agent.

  0 = DT_CROWDAGENT_STATE_INVALID 1 = DT_CROWDAGENT_STATE_WALKING 2 = DT_CROWDAGENT_STATE_OFFMESH

  Returns number

target

• target(): Vector3

• Returns the next target position on the path to the target

  Returns Vector3

teleport

• teleport(position): void

• Teleports the agent to the specified position.

  Parameters

  • position: Vector3

  Returns void

updateParameters

• updateParameters(crowdAgentParams): void

• Updates the agent's parameters. Any parameters not specified in the crowdAgentParams object will be unchanged.

  Parameters

  • crowdAgentParams: Partial<CrowdAgentParams>

    agent parameters to update.

  Returns void

velocity

• velocity(): Vector3

• The actual velocity of the agent. The change from velocityDesiredObstacleAdjusted -> velocity is constrained by max acceleration.

  Returns Vector3