stingray.GwNavTagLayerCostTable object reference

Description

Allows to customize GwNavTraverseLogicData.

Constructors and accessors

stingray.GwNavBot.navtag_layer_cost_table() stingray.GwNavTagLayerCostTable.create()

Other related reference items

	stingray.GwNavBot.navtag_layer_cost_table() stingray.GwNavBot.set_navtag_layer_cost_table() stingray.GwNavTraverseLogicData.set_navtag_layer_cost_table()
	Gameware Navigation

Functions

allow_layer ( self, layer_id ) Specifies which layers this bot can traverse.

Parameters

self :	stingray.GwNavTagLayerCostTable	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.
layer_id :	number	The layerID to allow.

Returns

This function does not return any values.

create ( ) : stingray.GwNavTagLayerCostTable Creates a GwNavTagLayerCostTable.

Parameters

This function does not accept any parameters.

Returns

stingray.GwNavTagLayerCostTable

The created GwNavTagLayerCostTable.

destroy ( self ) Destroys a GwNavTagLayerCostTable.

Parameters

self :

stingray.GwNavTagLayerCostTable

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.

forbid_layer ( self, layer_id ) Specifies which layers this bot cannot traverse.

Parameters

self :	stingray.GwNavTagLayerCostTable	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.
layer_id :	number	The layerID to forbid.

Returns

This function does not return any values.

set_layer_cost_multiplier ( self, layer_id, layer_cost_multiplier ) Specifies which cost multiplier must be used when traversing a given NavTag layer.

Parameters

self :	stingray.GwNavTagLayerCostTable	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.
layer_id :	number	The layerID to set.
layer_cost_multiplier :	number	The associated cost multiplier of this layer.

Returns

This function does not return any values.