stingray.GwNavGeneration object reference

Description

Functions used for generating NavData.

Only available on desktop (Windows, OSX) and consoles (xb1, ps4).

Constructors and accessors

stingray.GwNavGeneration.create()

Other related reference items

Gameware Navigation

Enumerations

stingray.GwNavGeneration.GenFlags Generation flags

Functions

add_generated_navdata_to_world ( self, nav_world, navdata_resource_name ) : stingray.GwNavData

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
nav_world :	stingray.GwNavWorld	The world to load the navdata into
navdata_resource_name :	string	navdata name

Returns

stingray.GwNavData

The NavData generated if added successfully, nil otherwise

Other related reference items

stingray.GwNavGeneration.enable_write_files()

add_navdata_file_to_world ( nav_world, navdata_filepath ) : boolean

Parameters

nav_world :	stingray.GwNavWorld	The world to load the navdata into
navdata_filepath :	string	Absolute path to .NavData file to load

Returns

boolean

if the NavData file was added successfully

begin_push_triangle ( self ) Must be called prior to calling push_triangle.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

All subsequent calls to push_triangle will have the same NavTag. The applied NavTag is the latest call to set_current_navtag or reset_current_navtag prior to begin_push_triangle.

create ( offset_sector, database_id ) : stingray.GwNavGeneration This create setup the generation for one level a.k.a.

Parameters

offset_sector :	stingray.Vector3?	The offset applied to the sector in order to generate NavData at the location the level will be loaded at runtime. The ? notation indicates that this type is optional: there may be zero or one instances of it.
database_id :	integer?	The id of the database the NavData will be loaded into. Default: 0 The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

stingray.GwNavGeneration

The GwNavGeneration used to run the generation

sectors.

create_sector_neighbors_iterator ( self ) : stingray.GwNavGenSectorNeighborsIterator

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

stingray.GwNavGenSectorNeighborsIterator

Allows to iterate over names of sector neighbors

database_id ( self ) : integer

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

integer

The database_id

destroy ( self )

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

destroy_sector_neighbors_iterator ( iterator )

Parameters

iterator :

stingray.GwNavGenSectorNeighborsIterator

The iterator to destroy

Returns

This function does not return any values.

enable_write_files ( self, enable ) Enable/disable file writing for the generation.

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
enable :	boolean	false to disable file writing. Otherwise, true which is the default.

Returns

This function does not return any values.

Use GwNavGeneration.generate then GwNavGeneration.add_generated_navdata_to_world in order to generate then add the generated NavData.

exclude_actor_shape_template ( self, actor_shape_template ) Any static actor with this shape template won't have its geometry shape consumed by the generation, so the generation will run as if this actor doesn't exist.

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
actor_shape_template :	string	The name of the physics actor shape template to exclude from the generation

Returns

This function does not return any values.

generate ( self, sector_name ) : boolean Generate NavData

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
sector_name :	string	Name for the sector to generate

Returns

boolean

Tells if the generation was successful

Other related reference items

stingray.GwNavGeneration.enable_write_files() stingray.GwNavGeneration.set_absolute_base_dir()

get_sector_change_status ( self, sector_name ) : stingray.GwNavGeneration.GenFlags

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
sector_name :	string	Name of the sector to set the status

Returns

stingray.GwNavGeneration.GenFlags

The status of the sector

next_sector_neighbor_name ( iterator ) : string

Returns

string

Next sector neighbor name

push_meshes_from_unit ( self, unit, consume_physics_mesh, consume_render_mesh ) Note that Terrains meshes are always consumed whatever the value of consume_physics_mesh.

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
unit :	stingray.Unit	The unit to consume meshes from
consume_physics_mesh :	boolean	Indicates if physics meshes of the unit should be consumed
consume_render_mesh :	boolean	Indicates if render meshes of the unit should be consumed

Returns

This function does not return any values.

Use set_current_navtag to apply a given NavTag to the pushed triangles.

push_seed_point ( self, position ) All parts of NavMesh not connected to this point will be removed from the final NavMesh.

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
position :	stingray.Vector3	Position of the seed point

Returns

This function does not return any values.

push_tagvolume_fromvolume ( self, polyline, altitude_min, altitude_max ) Use set_current_navtag to apply a given NavTag to the TagVolume.

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
polyline :	stingray.Vector3[]	An array of at least 3 Vector3 The [] notation indicates that this type is an array: a table in which the keys of the members are sequential integers, and the value of each element is an instance of the type shown.
altitude_min :	number	Altitude minimal of the tagvolume
altitude_max :	number	Altitude maximal of the tagvolume

Returns

This function does not return any values.

push_triangle ( self, A, B, C ) See begin_push_triangle to apply a NavTag to the triangle.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

reset_current_navtag ( self ) Reset current NavTag to default.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

sector_count ( self ) : integer

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

integer

Gives the number of sector from .GenIO file.

sector_name ( self ) : string

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

string

Gives the sector name from .GenIO file.

setup_from_genio_file ( self, genio_name, regenerate_all_navmeshes ) : boolean

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
genio_name :	string	Relative file path from absolute base directory where to load .GenIO file if it exists, and where to save it after the generation.
regenerate_all_navmeshes :	boolean	Indicates if other sectors should be regenerated form their .ClientInput file.

Returns

boolean

True if successful. False otherwise e.g. GwNavGeneration.set_absolute_base_dir was not called previously.

set_absolute_base_dir ( self, absoute_base_dir ) Required before GwNavGeneration.generate unless [GwNavGeneration.disable_file_writing] is called.

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
absoute_base_dir :	string	The directory where the generation will store the NavData and possibly write temporary files

Returns

This function does not return any values.

Other related reference items

stingray.GwNavGeneration.setup_from_genio_file()

set_altitude_tolerance ( self, value ) Determines the resolution used to sample and compare the altitude of the NavMesh to the altitude of the original raster, when altitude tolerance is enabled.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In meters.

set_cell_size ( self, value ) The length and width of each cell in the grid used internally to partition the NavMesh into cells.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In meters.

set_current_navtag ( self, is_exclusive, color, layer_id, smartobject_id, user_data_id ) Set the current navtag to apply to pushed triangles (cf.

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
is_exclusive :	boolean	Whether the NavTag associated with this obstacle causes the NavMesh to be untraversable.
color :	stingray.Quaternion?	The Color you would like the GwNavTagVolume to tag the NavMesh with. If nil, default color is applied. Unused if is_exclusive is true. The ? notation indicates that this type is optional: there may be zero or one instances of it.
layer_id :	number?	The layer you would like to associate with this GwNavTagVolume. Unused if is_exclusive is true. The ? notation indicates that this type is optional: there may be zero or one instances of it.
smartobject_id :	number?	The smartobject you would like to associate with this GwNavTagVolume. Unused if is_exclusive is true. The ? notation indicates that this type is optional: there may be zero or one instances of it.
user_data_id :	number?	The user data you would like to associate with this GwNavTagVolume. Unused if is_exclusive is true. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

This function does not return any values.

push_triangle, push_meshes_fromunit, or push_tagvolume_fromvolume)

set_do_log_configuration ( self, do_log_configuration )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
do_log_configuration :	boolean	true to enable the logging of the configuration when log report is enabled.

Returns

This function does not return any values.

set_do_log_per_sector_report ( self, do_log_per_sector_report )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
do_log_per_sector_report :	boolean	true to get log for each sector.

Returns

This function does not return any values.

set_do_log_report ( self, do_log_report )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
do_log_report :	boolean	true to enable log report which is disabled by default.

Returns

This function does not return any values.

set_do_log_report_details ( self, do_log_report_details )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
do_log_report_details :	boolean	true to get a detailed log report.

Returns

This function does not return any values.

set_do_multicore ( self, do_multicore )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
do_multicore :	boolean	false to disable use of multicore while generating. Otherwise, true which is the default on pc platforms.

Returns

This function does not return any values.

set_do_profile ( self, do_profile )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
do_profile :	boolean	true to enable profiling of the generation.

Returns

This function does not return any values.

set_entity_height ( self, value ) Height of Entity.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In meters.

set_entity_radius ( self, value ) Radius of Entity.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In meters.

set_heightfield_sampling ( self, value ) Density of sampling of Terrains.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

If 0, sampling is as accurate as the heightfield. In meters.

set_limited_memory_mode ( self, enable )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
enable :	boolean	true to limit use of memory and rely upon use of temporary disk files.

Returns

This function does not return any values.

set_min_navigable_surface ( self, value ) The minimum surface area any isolated NavMesh area may occupy, unless marked with a seed point.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In squared meters.

set_raster_precision ( self, value ) The length and width of each pixel used to rasterize the input triangles.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In meters.

set_sector_change_status ( self, sector_name, gen_flags_sector_change )

Parameters

self :	stingray.GwNavGeneration	Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.
sector_name :	string	Name of the sector to set the status
gen_flags_sector_change :	stingray.GwNavGeneration.GenFlags	Indicates the status of the sector

Returns

This function does not return any values.

set_slope_max ( self, value ) The maximum slope that the character can walk on.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In degrees.

set_step_max ( self, value ) The maximum difference in altitude that a character can traverse in its normal walking movement.

Parameters

self :

stingray.GwNavGeneration

Specifies the object instance that this function will act on. You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

Returns

This function does not return any values.

In meters.