Class NavigationSettings

constructor

• new NavigationSettings(isInternalConstructor?): NavigationSettings

• Parameters

  • OptionalisInternalConstructor: boolean

  Returns NavigationSettings

agentHeight

• 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

agentRadius

• 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

isAutomaticVoxelSizeEnabled

• get isAutomaticVoxelSizeEnabled(): boolean

• Returns boolean

• set isAutomaticVoxelSizeEnabled(value): void

• Parameters

  • value: boolean

  Returns void

maximumClimbHeight

• 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

maximumSlopeAngle

• 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

  • value: rsx.Degree

  Returns void

mergeRegionSize

• 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

minimumRegionSize

• 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

tileSize

• 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

voxelHeight

• 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

voxelWidth

• 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

markAsDirty

• markAsDirty(dirtyFlags): void

• Marks the object as dirty.

  Parameters

  • dirtyFlags: EnumValue<ManagedSettingsDirtyFlag, number>

    Flags specifying what kind of member was changed.

  Returns void

modify

• modify(action): 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.

    • • (): void

      • Returns void

  Returns void

ReadonlyonDirty