ericoporto
commented
1 year ago Here’s a small sketch;
The Log Panel in AGS Editor can be useful for understanding and troubleshooting issues in your game, when the debugger alone isn’t enough. It provides a runtime log that includes warning messages and other notifications raised by the AGS engine or your own messages in your own scripts.
The Log Panel displays messages from three Log Groups:
- Script: These messages are generated by calling the System.Log function in your own script functions. They can be utilized for debugging purposes and understanding the flow of your code.
- Game: Messages in this group are generated by the AGS engine's internal game logic, they can also warn you if something in your script is misbehaving and being corrected by the engine without aborting the game.
- Main: Messages in this group are generated by the AGS engine concerning the interface between the engine and the platform or system it's running on.
Note: Log messages from the Script group can still be accessed in release builds of your game by running it through the command line and passing the necessary flags.
To control the log output, you can pause or resume the log display by clicking the pause or run buttons located at the top left of the Log Panel.
By default, the log panel will scroll to show the latest message added, but this behavior can be disabled by clicking on the auto glue button.
Additional functionality includes the ability to copy and clear the message buffer. When starting a new debug session, the log messages are cleared by default, ensuring a fresh log for each session.
The font size of the log panel can be adjusted according to your preferences in the Editor Preferences.
reference
Need to add a see also for
- Runtime Engine, because of the file logging, which is what is usually available in the player computer.
- System.Log
- LogLevel Enum, the only reference to the order of priority
- probably some explanation of what the filter means , that if you have a 3 you also get something from 2 and 1 and things like this
Trying to explain what each log level sorta should mean. (reference)
- Alert : a really important information
- Fatal : a failure that should abort the game or cause it to misbehave
- Error : something isn’t working that should work, this should not happen in normal execution
- Warn : an unexpected behavior happened, but it can recover and continue to work, may be relevant when an issue happens
- Info : informative, doesn’t demand an action and can normally be ignored
- Debug : more granular information that is useful usually when debugging if there is an issue in the behavior expected
Subj.