Skip to content

Debugging

Broström.A | Evul edited this page Sep 26, 2018 · 14 revisions

cScripts have functions for debugging and to avoid preformence loss there are as little logging as done as possible outside debugging environment.

To enable debugging you uncomment the highlighted line in script_component.hpp or add #define DEBUG_MODEat the top of the function you wish to debug.

Ofcause you sometimes need or whant more logging during development. But after removing this logging you might whant to add debug logging to help future developer be able to know what happens after the function is executed or when it is executed.

There are three debug functions in cScripts; logError, logWarning and logInfo. Mainly what this functions do is to format your error message and add a prefix. In the rpt log. Exsample:

>>> private _var = 'exsample';
>>> format['I am a %1 warning.', _var] call FUNC(logWarning)
[cScripts] WARNING: I am a exsample warning.

This allow you to easy see and follow your function in the rpt log.

In order to log only when you have debug is enable you write:

#ifdef DEBUG_MODE
    ["Exsample log"] call FUNC(logInfo);
#endif

This will allow a message to only be shown when #define DEBUG_MODE is defined (written att the top of the file or enabled via script_component.hpp.)

cScripts Development Wiki

Clone this wiki locally