engine.console Functions

This set of functions controls console-related parameters.

void engine.console.addCommand (string name, string description, string function)

Adds a custom console command bound to a given script function. The command can have up to 6 arguments, which will be passed to the script function.

The example shows how to add a custom console command with 2 arguments:

namespace Test {
    
    // A script function to be performed for no arguments input.
    void my_command_callback() {
        log.message("my_command callback\n");
    }

    // A script function to be performed for one argument input.
    void my_command_callback(string arg_0) {
        log.message("my_command callback arg_0 :%s\n",arg_0);
    }

    // A script function to be performed for two arguments input.
    void my_command_callback(string arg_0,string arg_1) {
        log.message("my_command callback arg_0:%s, arg_1:%s\n",arg_0,arg_1);
    }
}

/*
 */
int init() {
    engine.console.addCommand("my_command","my_command description","Test::my_command_callback");
    return 1;
}

/*
 */
int shutdown() {
    engine.console.removeCommand("my_command");
    return 1;
}

// Input value: my_command 
my_command callback

// Input value: my_command 1
my_command callback arg_0 :1

// Input value: my_command 1 2
my_command callback arg_0 :1 arg_1 :1 

Arguments

• string name - Name of the new console command.
• string description - Short description to be displayed in the console.
• string function - Name of the target script function.

void engine.console.flush ()

int engine.console.getActivity ()

Return value

float engine.console.getFloat (string variable)

Arguments

• string variable - Variable name.

Return value

int engine.console.getInt (string variable)

Arguments

• string variable - Variable name.

Return value

int engine.console.getLock ()

Return value

string engine.console.getString (string variable)

Arguments

• string variable - Variable name.

Return value

int engine.console.isCommand (string command)

Arguments

• string command - Command name.

Return value

int engine.console.isVariable (string variable)

Arguments

• string variable - Variable name.

Return value

void engine.console.print (string format, ... )

Arguments

• string format - Format of the text. See the formatting string description.
• ... - Arguments, multiple allowed.

void engine.console.removeCommand (string name)

Arguments

• string name - Name of the custom console command.

void engine.console.run (string command, ... )

Arguments

• string command - Console command.
• ... - Arguments to the command, multiple allowed.

Examples

// Run a console command to load a world
engine.console.run("world_load menu");

// Run a console command to change DOF mode
int mode = 3;
engine.console.run("render_dof %d && render_restart",mode);

void engine.console.setActivity (int state)

Arguments

• int state - Positive integer to make the console active (opened); otherwise, 0.

void engine.console.setBackgroundColor (vec4 color)

Arguments

• vec4 color - Four-component vector specifying the color in the RGBA format.

void engine.console.setErrorColor (vec4 color)

Arguments

• vec4 color - Four-component vector specifying the color in the RGBA format.

void engine.console.setFloat (string variable, float value)

Arguments

• string variable - Variable name.
• float value - Value of the variable.

void engine.console.setInt (string variable, int value)

Arguments

• string variable - Variable name.
• int value - Value of the variable.

void engine.console.setLock (int lock)

Arguments

• int lock - Positive integer to disable the console; otherwise, 0.

void engine.console.setMessageColor (vec4 color)

Arguments

• vec4 color - Four-component vector specifying the color in the RGBA format.

void engine.console.setPrompt (string prompt)

Arguments

• string prompt - New console prompt.

void engine.console.setString (string variable, string value)

Arguments

• string variable - Variable name.
• string value - Value of the variable.

void engine.console.setTextColor (vec4 color)

Arguments

• vec4 color - Four-component vector specifying the color in the RGBA format.

void engine.console.setWarningColor (vec4 color)

Arguments

• vec4 color - Four-component vector specifying the color in the RGBA format.