UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Migration
Migrating to UNIGINE 2.0
C++ API Migration
Migrating from UNIGINE 2.0 to UNIGINE 2.1

Working with Console

Calling a Console Command from Scripts

To call a console command from any of the scripts, you need to call engine.console.run().

Source code (UnigineScript)
// For example, to show messages:
engine.console.run("show_messages 1");

Console commands (regardless of whether they were typed in the console or called from a script) cannot not be executed in the middle of the frame. Instead, they are executed in the beginning of the next frame not to interrupt the current rendering process and physics calculations.

Creating a Console Command

To create a custom console command, you need to call engine.console.addCommand(). If you want your console command to take more than one argument, you need to implement separate functions per each number of arguments.
For example, we want our command to take one or two arguments.

Source code (UnigineScript)
// Create a console command
engine.console.addCommand("game_command","In-game console command","GameWorld::console");

// Implement a handler function with 1 argument
void console(string param1) {
	// do something
}

// Implement a handler function with 2 arguments
void console(string param1, string param2) {
	// do something
}

You can also remove custom console commands via engine.console.removeCommand().

Disabling Console

To disable console (for example, for application production version), you need to call engine.console.setLock().

Source code (UnigineScript)
// Disable the console
engine.console.setLock(1);
Last update: 2017-07-03