stingray.GwNavBoxObstacle object reference

Description

Represents a dynamic box obstacle.

Constructors and accessors

stingray.GwNavBoxObstacle.create() stingray.GwNavBoxObstacle.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 GwNavBoxObstacle to the world that was specified when it was created.

Parameters

self :

stingray.GwNavBoxObstacle

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, position, local_center, half_extents, is_exclusive, color, layer_id, smartobject_id, user_data_id ) : stingray.GwNavBoxObstacle Creates a GwNavBoxObstacle

Parameters

nav_world :	stingray.GwNavWorld	The GwNavWorld that this obstacle will belong to.
position :	stingray.Vector3	The position of the obstacle.
local_center :	stingray.Vector3	The center of rotation of the obstacle.
half_extents :	stingray.Vector3	The half extents of the box 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. Use stingray.Color(r,g,b) to create a color. 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 GwNavBoxObstacle. 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.GwNavBoxObstacle

The created obstacle.

create_exclusive ( nav_world, position, local_center, half_extents ) : stingray.GwNavBoxObstacle Creates a GwNavBoxObstacle with exclusive NavTag.

Parameters

nav_world :	stingray.GwNavWorld	The GwNavWorld that this obstacle will belong to.
position :	stingray.Vector3	The position of the obstacle.
local_center :	stingray.Vector3	The center of rotation of the obstacle.
half_extents :	stingray.Vector3	The half extents of the box obstacle.

Returns

stingray.GwNavBoxObstacle

The created obstacle.

destroy ( self ) Destroys a GwNavBoxObstacle.

Parameters

self :

stingray.GwNavBoxObstacle

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_tagvolume_integration_status ( self ) : stingray.GwNavTagVolume.IntegrationStatus

Parameters

self :

stingray.GwNavBoxObstacle

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

Integration status of GwNavBoxObstacle's internal GwNavTagVolume.

remove_from_world ( self ) Removes the given GwNavBoxObstacle from the nav_world that was specified when it was created.

Parameters

self :

stingray.GwNavBoxObstacle

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.

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

set_angular_velocity ( self, angular_velocity ) Sets the current angular velocity of the specified GwNavBoxObstacle.

Parameters

self :	stingray.GwNavBoxObstacle	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.
angular_velocity :	stingray.Vector3	The angular_velocity of the obstacle.

Returns

This function does not return any values.

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

Parameters

self :	stingray.GwNavBoxObstacle	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.
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 GwNavBoxObstacle.

set_linear_velocity ( self, linear_velocity ) Sets the current linear velocity of the specified GwNavBoxObstacle.

Parameters

self :	stingray.GwNavBoxObstacle	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.
linear_velocity :	stingray.Vector3	The linear velocity of the obstacle.

Returns

This function does not return any values.

set_rotation_mode_around_yaw_only ( self, rotates_around_yaw ) Sets the rotation mode of the GwNavBoxObstacle, either it will rotate around yaw, or it will rotate freely.

Parameters

self :	stingray.GwNavBoxObstacle	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.
rotates_around_yaw :	boolean	If true the obstacle will only rotate around the up axis of the world (e.g. 0,0,1 by default).

Returns

This function does not return any values.

set_transform ( self, transform ) Sets the current transform of the specified GwNavBoxObstacle.

Parameters

self :	stingray.GwNavBoxObstacle	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.
transform :	stingray.Matrix4x4	The transform of the the obstacle.

Returns

This function does not return any values.