Log Class
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
This class represents an interface for printing various types of messages to the console and to the Engine's log file. It can be useful to monitor overall progress of application execution and report errors which can be helpful in the process of debugging.
To enable displaying system messages in the Console use the following command: console_onscreen 1
There are two custom color schemes highlighting log syntax for Notepad++ included in the SDK:
- <SDK>/utils/log_styles/notepad_light.xml
- <SDK>/utils/log_styles/notepad_dark.xml
By default all logged messages are saved to the Engine's log file, and printed to stdout, the latter may significantly affect peformance in case of much logging. If logging causes performance issues, you can control the two logging targets via the following console commands:
Example#
The following code demonstrates how to print various types of messages.
Log Class
Members
void log.error ( string format, ... ) #
Prints an error message to the console and the log file.Arguments
- string format - Error message to print.
- ... - Arguments, multiple allowed.
void log.fatal ( string format, ... ) #
Prints a fatal error message to the log file and quits the engine.Arguments
- string format - Fatal error message to print.
- ... - Arguments, multiple allowed.
void log.message ( string format, ... ) #
Prints a message to the console and the log file.Arguments
- string format - Message to print.
- ... - Arguments, multiple allowed.
void log.warning ( string format, ... ) #
Prints a warning to the console and the log file.Arguments
- string format - Warning to print.
- ... - Arguments, multiple allowed.
Last update:
2022-12-14
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)