Class CrowdAgent

constructor

• new CrowdAgent(crowd: Crowd, agentIndex: number): CrowdAgent

  Parameters

  • crowd: Crowd
  • agentIndex: number

  Returns CrowdAgent

agentIndex

crowd

interpolatedPosition

raw

collisionQueryRange

• get collisionQueryRange(): number

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

  Returns number

  Default

  2.5
  Copy

• set collisionQueryRange(value: number): void

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

  Parameters

  • value: number

  Returns void

  Default

  2.5
  Copy

height

• get height(): number

  The height of the agent.

  Returns number

  Default

  1
  Copy

• set height(value: number): void

  The height of the agent.

  Parameters

  • value: number

  Returns void

  Default

  1
  Copy

maxAcceleration

• get maxAcceleration(): number

  The maximum allowed acceleration for the agent.

  Returns number

  Default

  20
  Copy

• set maxAcceleration(value: number): void

  The maximum allowed acceleration for the agent.

  Parameters

  • value: number

  Returns void

  Default

  20
  Copy

maxSpeed

• get maxSpeed(): number

  The maximum allowed speed for the agent.

  Returns number

  Default

  6
  Copy

• set maxSpeed(value: number): void

  The maximum allowed speed for the agent.

  Parameters

  • value: number

  Returns void

  Default

  6
  Copy

obstacleAvoidanceType

• get obstacleAvoidanceType(): number

  The index of the avoidance configuration to use for the agent. [Limits: 0 <= value <= #DT_CROWD_MAX_OBSTAVOIDANCE_PARAMS]

  Returns number

  Default

  0
  Copy

• set obstacleAvoidanceType(value: number): void

  The index of the avoidance configuration to use for the agent. [Limits: 0 <= value <= #DT_CROWD_MAX_OBSTAVOIDANCE_PARAMS]

  Parameters

  • value: number

  Returns void

  Default

  0
  Copy

pathOptimizationRange

• get pathOptimizationRange(): number

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

  Returns number

  Default

  0
  Copy

• set pathOptimizationRange(value: number): void

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

  Parameters

  • value: number

  Returns void

  Default

  0
  Copy

queryFilterType

• get queryFilterType(): number

  The index of the query filter used by this agent.

  Returns number

  Default

  0
  Copy

• set queryFilterType(value: number): void

  The index of the query filter used by this agent.

  Parameters

  • value: number

  Returns void

  Default

  0
  Copy

radius

• get radius(): number

  The radius of the agent.

  Returns number

  Default

  0.5
  Copy

• set radius(value: number): void

  The radius of the agent.

  Parameters

  • value: number

  Returns void

  Default

  0.5
  Copy

separationWeight

• get separationWeight(): number

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

  Returns number

  Default

  0
  Copy

• set separationWeight(value: number): void

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

  Parameters

  • value: number

  Returns void

  Default

  0
  Copy

updateFlags

• get updateFlags(): number

  Flags that impact steering behavior.

  Returns number

  Default

  7
  Copy

• set updateFlags(value: number): void

  Flags that impact steering behavior.

  Parameters

  • value: number

  Returns void

  Default

  7
  Copy

userData

• get userData(): unknown

  User defined data attached to the agent.

  Returns unknown

  Default

  0
  Copy

• set userData(value: unknown): void

  User defined data attached to the agent.

  Parameters

  • value: unknown

  Returns void

  Default

  0
  Copy

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: Vector3): boolean

  Updates the agent's target.

  Parameters

  • position: Vector3

    The new target position.

  Returns boolean

  True if the request was successful.

requestMoveVelocity

• requestMoveVelocity(velocity: Vector3): 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: Partial<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: Vector3): void

  Teleports the agent to the specified position.

  Parameters

  • position: Vector3

  Returns void

updateParameters

• updateParameters(crowdAgentParams: Partial<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