Class NavigationSettings

The NavigationSettings struct contains values used to specify how Navigation data is created.

Hierarchy

  • FrameworkObject
    • NavigationSettings

Constructors

Accessors

  • get agentHeight(): 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 agentHeight(value): void
  • Parameters

    • value: number

    Returns void

  • get agentRadius(): 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 agentRadius(value): void
  • Parameters

    • value: number

    Returns void

  • get isAutomaticVoxelSizeEnabled(): boolean
  • Enables automatic voxel size computation based on agent height and radius properties. This ensures that the agent always consistently fits through narrow places.

    Returns boolean

  • set isAutomaticVoxelSizeEnabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get maximumClimbHeight(): number
  • The maximum ledge height in world units (m) that is considered to still be traversable by the agent.

    The average trained male is about to jump between 0.6m to 0.7m.

    Returns number

  • set maximumClimbHeight(value): void
  • Parameters

    • value: number

    Returns void

  • get maximumSlopeAngle(): rsx.Degree
  • The maximum slope that is considered walkable by the agent.

    A average trained male is able to go up a slope of about 45 to 50 degrees.

    Returns rsx.Degree

  • set maximumSlopeAngle(value): void
  • Parameters

    Returns void

  • get mergeRegionSize(): number
  • Any regions with a span count smaller than this value will, if possible be merged with larger regions.

    Returns number

  • set mergeRegionSize(value): void
  • Parameters

    • value: number

    Returns void

  • get minimumRegionSize(): number
  • The minimum number of cells allowed to form isolated island areas.

    Returns number

  • set minimumRegionSize(value): void
  • Parameters

    • value: number

    Returns void

  • get tileSize(): number
  • The voxel size of a navigation tile. Smaller tiles may process faster, but can cause sub-optimal paths.

    Returns number

  • set tileSize(value): void
  • Parameters

    • value: number

    Returns void

  • get voxelHeight(): number
  • The height of a voxel in world-space when not using automatic voxel size computation.

    Returns number

  • set voxelHeight(value): void
  • Parameters

    • value: number

    Returns void

  • get voxelWidth(): number
  • The width of a voxel in world-space when not using automatic voxel size computation.

    Returns number

  • set voxelWidth(value): void
  • Parameters

    • value: number

    Returns void