stingray.GwNavDebug namespace reference

Description

Functions used for debugging and only defined in development builds.

Do not use in your final builds.

Other related reference items

Gameware Navigation

Development Only

The elements in this group are only available in development builds.

Do not use them in your final builds.

enable_navlog_lua_line ( enable ) Enable or disable concatenation of the calling lua line to any log done by Navigation.

Parameters

enable :

boolean

true to enable or false to disable

Returns

This function does not return any values.

get_check_opaque_types ( ) : boolean

Parameters

This function does not accept any parameters.

Returns

boolean

return true if enable

get_enable_navlog_lua_line ( ) : boolean

Parameters

This function does not accept any parameters.

Returns

boolean

return true if enable

get_file_line ( stack_level ) : string?, integer? Look for lua source file and line at the given level in the lua stack, if no stack_level is passed it defaults to 1 and so returns file and line of the call to get_file_line itself.

Parameters

stack_level :

integer?

The level to look for the file and line in the lua stack. It should be greater or equal to 1. The ? notation indicates that this type is optional: there may be zero or one instances of it.

Returns

string?	The lua source file. The ? notation indicates that this type is optional: there may be zero or one instances of it.
integer?	The line in the source file. The ? notation indicates that this type is optional: there may be zero or one instances of it.

nil is returned if no lua source file and line are found.

navlog_error ( message ) Log the message as error

Parameters

message :

string

The message to log

Returns

This function does not return any values.

navlog_info ( message ) Log the message as info

Parameters

message :

string

The message to log

Returns

This function does not return any values.

navlog_warning ( message ) Log the message as warning

Parameters

message :

string

The message to log

Returns

This function does not return any values.

run_internal_tests ( ) Run internal tests

Parameters

This function does not accept any parameters.

Returns

This function does not return any values.

set_check_opaque_types ( enable ) Enable or disable verification of opaque types.

Parameters

enable :

boolean

true to enable or false to disable

Returns

This function does not return any values.

It should be changed before creating any Navigation object.