Menu
Lumberyard
User Guide (Version 1.14)

Using the Console Window

In Lumberyard Editor, the console window shows a running list of all editor commands, processes, and output. For example, when you delete an entity, the console shows the action and the output. You can use the console to enter or modify console variables (CVARs). Console variables are a type of variable that you can manipulate in Lumberyard Editor.

Viewing the Console Window

You can type commands directly in the console window or search and edit console variables.

To view the console window

  1. In Lumberyard Editor, choose Tools, Console.

  2. Click the X icon in the left corner to open the Console Variables window. The Console Variables window lists all available console variables.

    
                        View all available console variables in the console window.
  3. Type a name to search for a specific console variable. To learn more about the console variable, pause on the name.

    
                        View console variables in the console window.

Exporting All Console Commands and Variables

You can retrieve a complete list of console commands and variables, including their descriptions and assigned values.

To export a list of all console commands and variables

  1. In the Console window, type the following command: DumpCommandsVars

  2. Navigate to the lumberyard_version\dev\ directory and then open the consolecommandandvars.txt file.

    Example

    You can see the available commands and variables in the file.

    
                            Open the consolecommandandvars.txt file to see all console commands and variables.
  3. You can specify a sub-string parameter to restrict the results that you want. For example, the DumpCommandsVars i_ command exports all commands and variables that begin with the prefix i_, such as i_giveallitems and i_debug_projectiles.

Configuring Console Variables

Console variables can also be set in code, flow graphs, or specified in configuration files. Console variables are executed in the following order:

  1. Configuration files:

    • The game.cfg file in your project directory

    • The lumberyard_version\dev\system_gamesystem.cfg file for your game system

    • The lumberyard_version\dev\engine\config\user.cfg file

    • The level.cfg file in your project's level directory

  2. Code

  3. Flow graphs

  4. Console variables typed directly into the console

The order of execution is also the override order. For example, console variables set in code override those set in configuration files (and level.cfg overrides user.cfg, and so on). Console variables set in flow graphs override any identical console variables set in code. Finally, console variables typed directly into the console override all the other console variable settings.

Configuring Console Variables in the Console

You can specify values for console variables in the console to apply changes to your level.

To configure console variables in the console

  • Do one of the following:

    • In the Console Variables window, search for the variable name, double-click the value, and then type the value that you want.

    • In the Console command line, type the console variable and its value, and then press Enter. For example, type the r_DisplayInfo=1 command to display debugging information in the viewport.

Configuring Console Variables in Configuration Files

You can specify values for console variables in the configuration files, such as the level configuration file ( level.cfg).

To configure console variables with a configuration file

  1. Navigate to the directory that has the configuration file. For example, if you want to configure the level.cfg file, navigate to the lumberyard_version\dev\ProjectName\Levels\level_name directory.

  2. Use a text editor to edit the file or to create one.

  3. Specify the console variable name and the value. For example: r_DisplayInfo=1 shows debugging information in the viewport.

  4. Save the file.