stingray.GwNavSmartObjectInterval object reference

Description

Represents the Entrance and Exit points for a [GwNavSmartObject].

Constructors and accessors

stingray.GwNavSmartObjectInterval.create()

Other related reference items

	stingray.GwNavBot.current_or_next_smartobject_interval() stingray.GwNavBot.enter_manual_control() stingray.GwNavBot.exit_manual_control()
	Gameware Navigation

Functions

can_traverse_smartobject ( self ) : boolean Returns if the GwNavSmartObjectInterval can be traversed.

Parameters

self :

stingray.GwNavSmartObjectInterval

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

Tells if the smartobject id is still allowed in GwNavWorld' smartobject/cost table.

create ( navworld ) : stingray.GwNavSmartObjectInterval Creates a GwNavSmartObjectInterval.

Parameters

navworld :

stingray.GwNavWorld

The GwNavWorld that this interval will be used with.

Returns

stingray.GwNavSmartObjectInterval

The created GwNavSmartObjectInterval.

destroy ( self ) Destroys a GwNavSmartObjectInterval.

Parameters

self :

stingray.GwNavSmartObjectInterval

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.

entrance_position ( self ) : stingray.Vector3, boolean Returns the entrance position of a GwNavSmartObjectInterval.

Parameters

self :

stingray.GwNavSmartObjectInterval

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.Vector3	The entrance position.
boolean	true if the bot is currently stood at the entrance position.

exit_position ( self ) : stingray.Vector3, boolean Returns the entrance position of a GwNavSmartObjectInterval.

Parameters

self :

stingray.GwNavSmartObjectInterval

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.Vector3	The exit position.
boolean	true if the bot's path ends at the exit position.

smartobject_id ( self ) : integer Returns the SmartObject id of a GwNavSmartObjectInterval.

Parameters

self :

stingray.GwNavSmartObjectInterval

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 id of the SmartObject.