Navigation options

Select Window > Navigation to access the following Navigation Options in Stingray.

Limited memory mode

Limits the memory usage for NavMesh generation by using temporary files on disk. Can be much slower.

Generate NavMesh

Click to generate NavData.

Delete NavMesh

Click to delete the generated NavData.

Database

These options specify which Navigation database the generated NavMesh will belong to.

Database Name

Name of the database which must be unique.

Database ID

ID of the database which must be unique and in the range [0, database_count-1] where database_count is the value passed to stingray.GwNavWorld.create(transform, database_count).

Consumption

These options specify how to generate the NavMesh.

Excluded custom script data

By default, the NavMesh generation consumes the Render meshes of all Units except if script data of the Unit contains:

one of the script data listed into Excluded custom script data field (a comma-separated list)

gwnavgenexcluded script data set to true

LevelEditor/is_gizmo_unit set to true

one of these script data: GwNavBoxObstacle, GwNavCylinderObstacle, GwNavTagBox, GwNavBot which represent Units that can be moved at runtime

Consume Mesh

Select which mesh of a Unit is consumed for the NavMesh generation.

Render Mesh : consume the mesh used for rendering the Unit.

Physics Actor : consume the physics actors of Unit.

The behavior can also be overridden at the Unit level by adding boolean script data gwnavgen_fromphysicsmesh and/or gwnavgen_fromrendermesh.
Note that terrains (heightfield physics actors) are always consumed regardless of Consume Mesh value, though script data exclusion still applies.

Excluded Physics Actor Shape Template

When Physics Actor is selected to consume meshes, the NavMesh generation will consume all static actors except if their shape template is listed in the Excluded Physics Actor Shape Template field (a comma-separated list)

Terrain Sampling

Terrain sampling size in meters. If set to 0, the sampling consumes the heightfield as-is.

Autoseed script data

Comma separated list of script data. All units that have one of these script data (e.g. GwNavBot, GwNavTagBox, MyJump, MySpawn...) will create a seedpoint at their position as if they add a gwnavseedpoint script data set to true

Level Offset

Offset to apply to the current level for NavMesh generation.

Entity Settings

Entity radius

The radius (or half-width) of the character, in meters, that will use the NavData at runtime. Default 0.4.

This value is used to prevent characters from colliding with walls at runtime by keeping the navMesh borders at a distance from the walls.

Entity height

The height, in meters, of the characters that can use this NavMesh, in meters. Default 1.6.

Slope max

The maximum slope, in degrees, for a triangle in the terrain mesh to be considered navigable.

Determines how steep a slope a character can traverse in its normal walking movement. For example, a mountainside (SlopeMax=80) might be easy for a giant spider or a mountain goat to traverse, but impossible for a human.

The maximum difference in altitude that the character that will use the NavData at runtime can traverse in its normal movement.

Step max

The maximum difference in altitude, in meters, that is considered navigable between neighboring pixels in the raster created from the terrain mesh.

NavMesh

Raster precision

Determines the approximate width and length of each pixel used to rasterize the input triangles. Default is 0.2.

Note: To make sure this value is a multiple of the original rasterization pixel size, any value less than twice the pixel size is clamped to the pixel size, values between 2.0f and 3.0f times the pixel size are clamped to twice the pixel size.

Altitude tolerance

The maximum difference in altitude that may exist between the NavMesh and the original terrain mesh.

Specifies how precisely the generated NavMesh follows the altitude of the original terrain mesh. The higher the value, the closer the match, which produces a NavMesh with more, smaller triangles.

Min surface

Sets the minimum navigable surface area, in square meters, that any isolated area of NavMesh can occupy. Default 0.5.

Any NavMesh with a total surface area smaller than this value is discarded unless a SeedPoint is placed in this region.

Cell size

Sets the size (length and width) of the internal cell partitioning grid. Default is 20. Sets the number of raster pixels that make up the length and width of each cell.

Multilevels

Use Multilevels generation

Click to enable multilevels generation.

Regenerate NavMesh for all levels

Regenerate NavMeshes of all levels using cached input from previous generation of other levels (i.e., .ClientInput files). To regenerate .ClientInput run generation of each level individually. Also, note this is automatically checked if settings were changed.

Multilevels Resource Name

Resource name for Multilevels file.

Multilevels List

Resource name of all levels implied in multilevels generation. If this level is not in the list, this field would be automatically filled if Multilevels Resource Name sjson file contains an initial_level_offset_list object associating levels to their offset. The offset of current level will also be updated accordingly. If no such entry is found, this level will be added to this list.

Level Viewport Options

Render NavMesh

Controls whether the NavMesh (once generated) displays on top of the consumed level geometry.

Render NavMesh for neighbor levels

Render NavMesh of neighbor levels in multilevels build only apply if Render NavMesh is checked.

Selection

These parameters have no effect on the generation. They are only there to help understand which Units are taken into account or not.

Filter out by script data

Comma separated list of script data. Units with one of these script data listed here won't be selected when clicking on one of the select buttons.

Filter out by Unit subname

Comma separated list of string. Units whose name contains one of the listed strings won't be selected when clicking on one of the Select Units buttons.

Select Units included into NavMesh generation.

This button selects all units that will be included in the NavMesh Generation. Useful to verify what the generation will take into account. Some units can be hidden from the results by using the filters.

Select Units excluded from NavMesh generation.

This button selects all units that will NOT be included in the NavMesh Generation. Useful to verify what the generation will take into account. Some units can be hidden from the results by using the filters.