Console
Console quick reference
Cvar listings
Doom 3 CVar listing Resurrection of Evil specific CVars Quake 4 CVar listing Prey CVar listing ET:QW CVar listing Console command listings
Doom 3 console command listing Resurrection of Evil specific console commands Quake 4 console command listing Prey console command listing ET:QW console command listing Impulse listing
Impulses (key and button bindings)
The console is a fundamental part of id Tech 4 games: it is used for example to relate debug to the developer and status information for troubleshooting general game problems. To access the console you need to press “Ctrl + Alt + ~”. To simplify access to the console take a look here . Aside from gaining information you can also interact with the engine through CVars and Commands.
- Note: Wolfenstein only:
- (SP) com_allowConsole must be set via command line or wolf.cfg for console access.*
CVars
CVar’s (console variables) are used to hold scalar or string variables that can be changed or displayed at the console as well as accessed directly in code. CVars are mostly used to hold settings that can be changed from the console or saved to and loaded from the configuration files . CVars are also occasionally used to communicate information between different modules of the program, and new CVars can be created on mods.
CVars are restricted from having the same names as console commands to keep the console interface from being ambiguous. CVars can be accessed from the console in four ways:
INPUT | RESULT |
---|---|
cvarName | Prints the current value and a short description. |
cvarName [X] | Sets the value to X if the variable exists. |
set cvarName [X] | As above, but creates the CVar if not present. |
seta cvarName [X] | As above, but also stores the CVar value in [game]config.cfg so that it will be the default value. Never use seta on the command line! |
conCommand $cvarName | Executes a given console command using the value of the specified CVar as input. |
A full list of the cvars, and a brief description can be generated using the listCvars console command.
It should be noted that many cvars are not intended to be changed by players, and are intended only for developers / mappers. Many of these cvars are marked as “cheat protected”, which is indicated by CH in the output of cvarList. Cheat protected cvars cannot be modified from the default values during online play and so have no effect, but if tweaked can have a negative effect on single-player games, or when watching demos or using the various editors, as these respect cheat protected cvars. Therefore, it is strongly recommended that players do not adjust cheat protected cvars unless they know the specific effect of that CVar.
Console commands
Console commands are instructions that are typed directly into the console to perform various tasks. These tasks may range from things users may wish to do (eg recordNetDemo to record a demo of the current multiplayer game), through to internal functions used by the game (such as updateSI which triggers a refresh of the serverinfo data).
Some commands require one or more parameters, most will report their usage by typing them without parameters. A full list of console commands and a brief description can be generated using the listCmds console command.
They can also be used indirectly, for instance through GUI scripts by using the set command , or programmtically changed via the game-code or engine via the cvarSystem interface.