stingray.GwNavTagVolume object reference

Description

Represents a volume that tags the NavMesh dynamically.

Constructors and accessors

stingray.GwNavQueries.nav_tag_volume() stingray.GwNavTagVolume.create()

Other related reference items

	stingray.GwNavTagVolume.IntegrationStatus.DEINTEGRATION_IN_PROCESS stingray.GwNavTagVolume.IntegrationStatus.INTEGRATED stingray.GwNavTagVolume.IntegrationStatus.INTEGRATION_IN_PROCESS stingray.GwNavTagVolume.IntegrationStatus.NOT_INTEGRATED stingray.GwNavTagVolume.IntegrationStatus.TO_BE_DEINTEGRATED stingray.GwNavTagVolume.IntegrationStatus.TO_BE_INTEGRATED
	stingray.GwNavBoxObstacle.get_tagvolume_integration_status() stingray.GwNavCylinderObstacle.get_tagvolume_integration_status() stingray.GwNavGeneration.set_current_navtag() stingray.GwNavQueries.nav_tag_volume() stingray.GwNavWorld.register_tagvolume_for_crowd_dispersion()
	Gameware Navigation

Related help topics

Creating Gameplay > AI and pathfinding > Set up levels to use Gameware Navigation

Enumerations

stingray.GwNavTagVolume.IntegrationStatus TagVolume Integration Status

Functions

add_to_world ( self ) Adds a GwNavTagVolume to its world.

Parameters

self :

stingray.GwNavTagVolume

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.

create ( nav_world, polyline, min_altitude, max_altitude, is_exclusive, color, layer_id, smartobject_id, user_data_id ) : stingray.GwNavTagVolume Creates a GwNavTagVolume.

Parameters

nav_world :	stingray.GwNavWorld	The GwNavWorld to create this GwNavTagVolume in.
polyline :	table	A table of at least three Vector3
min_altitude :	number	Altitude min to extrude the polyline
max_altitude :	number	Altitude max to extrude the polyline
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

stingray.GwNavTagVolume

The created GwNavTagVolume.

destroy ( self ) Destroys a GwNavTagVolume.

Parameters

self :

stingray.GwNavTagVolume

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.

get_integration_status ( self ) : stingray.GwNavTagVolume.IntegrationStatus Retrieves integration status of GwNavTagVolume.

Parameters

self :

stingray.GwNavTagVolume

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.GwNavTagVolume.IntegrationStatus

The TagVolume integration status

navtag ( self ) : boolean, stingray.Quaternion, integer, integer, integer Retrieves information about the NavTag associated with the specified GwNavTagVolume.

Parameters

self :

stingray.GwNavTagVolume

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

boolean	Indicates whether or not the NavTag is exclusive: i.e. whether or not it can be navigated.
stingray.Quaternion	Indicates the color of the NavTag.
integer	Indicates the ID of the layer associated with the NavTag.
integer	Indicates the ID of the smartobject associated with the NavTag.
integer	Indicates the userdata associated with the NavTag.

remove_from_world ( self ) Removes a GwNavTagVolume from its world.

Parameters

self :

stingray.GwNavTagVolume

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.

It will not be destroyed, just removed and can be added again later.