Debug console

Debug console is third party module for collecting and showing developer logs in-game.

A great tool to track messages and bugs even in built game (the version, which is public, not only internal / simulated in editor).

Debug console is hidden by default and should not be accessed if player wanted experience the game how what it is been meant to play or experience (some messages contains data, which player can use for his advantage). But dont you wory. The count of usefull message will be reduced as game release is approaching.

This tool can be very useful when game crashes and you dont (as us) why. Simply try to access debug console and replicate what have you done.

How to access debug console
First, you have to access in-game console.

Then type command "debug".

Small panel will be shown at right side in the middle. Detailed panel is acced by clicking the small panel or by pressing "semicolon/tilde" button (the one usually located under Escape).

To hide Debug console simply repeat typing command "debug" to console.

Big (detailed) panel
As its smaller brother contains 3 types of messages. Each has different meaning. Lets look at them from small panel perspective up-down.


 * Debug/info - messages we developers are using for program giving us feedback of actual state of variables or location in code; informative only meaning
 * Warning - message we developers are using for waning us program has entered unwanted state; infromative too but it is taken as non-fatal error
 * Error - message that program is using to warn us developers, that program entered unwanted state by accessing unreachable memory or by doing unsafe execution of code; can be fatal



Error message
When you are using debug console, this message has critical meaning for us. So if you ever encounter any error message, enter detailed panel for more info. There is usually better and detailed log about what happend in form of stack state print out. Simply copy all the rows and send them to us via Bug report with brief message what precede it (to us replicate it and identify the problem).

The most usual message contains "Null pointer exception" error, which basically means program is trying to access object which is empty (null, unitialized). This may cause game crash or other errors to show up, it depends how much the calling is deep. What player will experience for sure is lack of execution of wanted action (like selecting item in game, moving, loading map, animation,...).