stingray.GwNavCylinderObstacle object reference

Description

Represents a dynamic cylinder obstacle.

Constructors and accessors

stingray.GwNavCylinderObstacle.create() stingray.GwNavCylinderObstacle.create_exclusive()

Other related reference items

Gameware Navigation

Related help topics

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

Functions

add_to_world ( self ) Adds the given GwNavCylinderObstacle to the world that was specified when it was created.

Parameters

self :

stingray.GwNavCylinderObstacle

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 Object lifetimes and userdata binding, or this page in the Lua documentation.

Returns

This function does not return any values.

create ( nav_world, position, height, radius, is_exclusive, color, layer_id, smartobject_id, user_data_id ) : stingray.GwNavCylinderObstacle Creates a GwNavCylinderObstacle.

Parameters

nav_world :	stingray.GwNavWorld	The GwNavWorld that this obstacle will belong to.
position :	stingray.Vector3	The position of the obstacle.
height :	number	The height of the obstacle.
radius :	number	The radius of the obstacle.
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 obstacle 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 obstacle. 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 obstacle. 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 GwNavCylinderObstacle. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

stingray.GwNavCylinderObstacle

The created obstacle.

create_exclusive ( nav_world, position, height, radius ) : stingray.GwNavCylinderObstacle Creates a GwNavCylinderObstacle with exclusive NavTag.

Parameters

nav_world :	stingray.GwNavWorld	The GwNavWorld that this obstacle will belong to.
position :	stingray.Vector3	The position of the obstacle.
height :	number	The height of the obstacle.
radius :	number	The radius of the obstacle.

Returns

stingray.GwNavCylinderObstacle

The created obstacle.

destroy ( self ) Destroys a GwNavCylinderObstacle.

Parameters

self :

stingray.GwNavCylinderObstacle

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 Object lifetimes and userdata binding, or this page in the Lua documentation.

Returns

This function does not return any values.

get_tagvolume_integration_status ( self ) : stingray.GwNavTagVolume.IntegrationStatus

Parameters

self :

stingray.GwNavCylinderObstacle

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 Object lifetimes and userdata binding, or this page in the Lua documentation.

Returns

stingray.GwNavTagVolume.IntegrationStatus

Integration status of GwNavCylinderObstacle's internal GwNavTagVolume.

remove_from_world ( self ) Removes the given GwNavCylinderObstacle from the world that was specified when it was created.

Parameters

self :

stingray.GwNavCylinderObstacle

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 Object lifetimes and userdata binding, or this page in the Lua documentation.

Returns

This function does not return any values.

The obstacle is not destroyed, it will simply be ignored.

set_does_trigger_tagvolume ( self, does_trigger ) If false, this GwNavCylinderObstacle will only be avoided by bots.

Parameters

self :	stingray.GwNavCylinderObstacle	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 Object lifetimes and userdata binding, or this page in the Lua documentation.
does_trigger :	boolean	Whether or not this obstacle punches a hole in the DynamicNavMesh.

Returns

This function does not return any values.

If true, the NavMesh will actually be modified by this GwNavCylinderObstacle.

set_position ( self, position ) Sets the current position of the specified GwNavCylinderObstacle, this will be taken into account during the next update.

Parameters

self :	stingray.GwNavCylinderObstacle	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 Object lifetimes and userdata binding, or this page in the Lua documentation.
position :	stingray.Vector3	The position of the obstacle.

Returns

This function does not return any values.

set_velocity ( self, velocity ) Sets the current velocity of the specified GwNavCylinderObstacle, this will be taken into account during the next update.

Parameters

self :	stingray.GwNavCylinderObstacle	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 Object lifetimes and userdata binding, or this page in the Lua documentation.
velocity :	stingray.Vector3	The velocity of the obstacle.

Returns

This function does not return any values.