stingray.GwNavGraph object reference

Description

Represents a graph of points.

Constructors and accessors

stingray.GwNavGraph.create()

Other related reference items

	stingray.GwNavWorld.register_all_navgraphedges_for_crowd_dispersion()
	Gameware Navigation

Functions

add_to_database ( self ) Adds the specified GwNavGraph.

Parameters

self :

stingray.GwNavGraph

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 ( database_or_world, bidirectional, points, color, layer_id, smartobject_id, user_data_id ) : stingray.GwNavGraph Creates a GwNavGraph.

Parameters

database_or_world :	any(stingray.GwNavWorld, stingray.GwNavDatabase)	The GwNavDatabase this graph will be added to. If a GwNavWorld, the default GwNavDatabase will be used. The any(...) notation indicates that this item may be an instance of any of the types shown in the parentheses.
bidirectional :	boolean	If true the edges are bidirectional. Otherwise, monodirectional.
points :	table	Table of pair of vector3 defining the edges.
color :	stingray.Quaternion?	The Color you would like the graph to be. 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 graph. 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 graph. 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 GwNavGraph. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

stingray.GwNavGraph

The created graph.

destroy ( self ) Destroys the specified GwNavGraph.

Parameters

self :

stingray.GwNavGraph

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.

remove_from_database ( self ) Removes the specified GwNavGraph from the database.

Parameters

self :

stingray.GwNavGraph

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, simply removed. As such it can be re-added later.