Class NavigationAgentProperties

constructor

• new NavigationAgentProperties(
      isInternalConstructor?: boolean,
  ): NavigationAgentProperties

  Parameters

  • OptionalisInternalConstructor: boolean

  Returns NavigationAgentProperties

behaviorFlags

• get behaviorFlags(): EnumValue<NavigationAgentFlags>

  Controls the agent's behavior.

  Returns EnumValue<NavigationAgentFlags>

• set behaviorFlags(value: EnumValue<NavigationAgentFlags>): void

  Parameters

  • value: EnumValue<NavigationAgentFlags>

  Returns void

height

• get height(): number

  The height of the agent in world units (m). The agent will not be able to walk through areas with a lower ceiling.

  The average male height is 1.75m.

  Returns number

• set height(value: number): void

  Parameters

  • value: number

  Returns void

isApplyingPosition

• get isApplyingPosition(): boolean

  Returns boolean

• set isApplyingPosition(value: boolean): void

  Parameters

  • value: boolean

  Returns void

isApplyingRotation

• get isApplyingRotation(): boolean

  Returns boolean

• set isApplyingRotation(value: boolean): void

  Parameters

  • value: boolean

  Returns void

maximumAcceleration

• get maximumAcceleration(): number

  The maximum acceleration.

  Returns number

• set maximumAcceleration(value: number): void

  Parameters

  • value: number

  Returns void

movementFlags

• get movementFlags(): EnumValue<NavigationAreaFlags>

  Determines the area types the agent can visit during path finding and navigation.

  Returns EnumValue<NavigationAreaFlags>

• set movementFlags(value: EnumValue<NavigationAreaFlags>): void

  Parameters

  • value: EnumValue<NavigationAreaFlags>

  Returns void

ownerHeightOffset

• get ownerHeightOffset(): number

  The offset to apply to the Y axis apply the agent position to the owning scene object. This helps to ensure correct position of the SceneObject when it is not anchored to the ground.

  Returns number

• set ownerHeightOffset(value: number): void

  Parameters

  • value: number

  Returns void

pathQuality

• get pathQuality(): EnumValue<FeatureQuality3>

  Determines the quality of the path the agent takes. Higher quality predict the path better, where the agent will attempt to shortcut if a direct path for visibile nodes can be taken. A higher path quality allows the agent to look further into distance at increased processing time. This setting also affects how a path is corrected if an agent was pushed away from its path due to factors such as agent separation or obstacles in the agent's path.

  Returns EnumValue<FeatureQuality3>

• set pathQuality(value: EnumValue<FeatureQuality3>): void

  Parameters

  • value: EnumValue<FeatureQuality3>

  Returns void

radius

• get radius(): number

  The radius of the agent in world units (m). The agent will not be able to walk through passages that are narrower than the the diameter of the agent.

  The average male shoulder-to-shoulder distance is about 0.5m which corresponds to a raidus of 0.25u.

  Returns number

• set radius(value: number): void

  Parameters

  • value: number

  Returns void

rotationAcceleration

• get rotationAcceleration(): number

  Controls how fast the agent responds to changes in the look direction.

  Returns number

  Note

  This value is used even if ApplyRotation is disabled for cases when the rotation is manually applied to the scene object.

• set rotationAcceleration(value: number): void

  Parameters

  • value: number

  Returns void

rotationSpeed

• get rotationSpeed(): rsx.Degree

  The maximum change of rotation per second in degrees.

  Returns rsx.Degree

• set rotationSpeed(value: rsx.Degree): void

  Parameters

  • value: rsx.Degree

  Returns void

separationWeight

• get separationWeight(): number

  Determines how far close agents stay apart from each other. Requires the AgentSeparation behavior flag to be set.

  Returns number

• set separationWeight(value: number): void

  Parameters

  • value: number

  Returns void

speed

• get speed(): number

  The maximum speed in meters per second.

  Returns number

• set speed(value: number): void

  Parameters

  • value: number

  Returns void

targetAreaSize

• get targetAreaSize(): number

  The maximum distance to the move goal at which the agent marks his move goal as completed and signals events.

  Returns number

• set targetAreaSize(value: number): void

  Parameters

  • value: number

  Returns void

markAsDirty

• markAsDirty(dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>): void

  Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action: () => void): void

  Allows modifying this object multiple times in a row in a scope, without marking the object dirty immediately. Dirty flags are accumulated and the object is marked dirty at the end.

  Parameters

  • action: () => void

    The scope where the object is modified.

  Returns void

ReadonlyonDirty