Engine:Console commands: Difference between revisions
Line 12: | Line 12: | ||
* In context by default | * In context by default | ||
* Default command is 'varedit' if in context | * Default command is 'varedit' if in context | ||
==== | ==== Global commands ==== | ||
: [[MACRO varedit|varedit]] - (none), / - Prints or sets variable, if variable exists and name is not another command. | : [[MACRO varedit|varedit]] - (none), / - Prints or sets variable, if variable exists and name is not another command. | ||
: [[MACRO var|var]] - var, /var - Creates a variable. If already exists, then does not change value. | : [[MACRO var|var]] - var, /var - Creates a variable. If already exists, then does not change value. | ||
Line 22: | Line 22: | ||
: [[MACRO bind|context]] - context, /context - Change context. Change current console context to another known context. | : [[MACRO bind|context]] - context, /context - Change context. Change current console context to another known context. | ||
: [[MACRO bind|run]] - run, /run - Load and run script file. Run a named script file. Name must include extension. | : [[MACRO bind|run]] - run, /run - Load and run script file. Run a named script file. Name must include extension. | ||
==== | ==== Global vars ==== | ||
: [[CVAR lib_path|lib_path]] - './lib/' - Path for native 'world' modules. | : [[CVAR lib_path|lib_path]] - './lib/' - Path for native 'world' modules. | ||
: [[CVAR lib_path|base_path]] - './data/' - Path for content and assets. | : [[CVAR lib_path|base_path]] - './data/' - Path for content and assets. | ||
Line 30: | Line 30: | ||
: [[CVAR lib_path|map]] - 'maps/base1.bsp' - Full path for default content module. | : [[CVAR lib_path|map]] - 'maps/base1.bsp' - Full path for default content module. | ||
: [[CVAR lib_path|startup]] - (none) - Full path of initial startup script. | : [[CVAR lib_path|startup]] - (none) - Full path of initial startup script. | ||
==== Assignments ==== | ==== Assignments ==== | ||
: Explicit context name is 'global' | : Explicit context name is 'global' | ||
Line 37: | Line 36: | ||
=== Render module === | === Render module === | ||
==== | ==== Global commands ==== | ||
: none | : none | ||
==== | ==== Global vars ==== | ||
: [[CVAR r_width|r_width]] - '900' - Initial main window height. | : [[CVAR r_width|r_width]] - '900' - Initial main window height. | ||
: [[CVAR r_height|r_height]] - '600' - Initial main window width. | : [[CVAR r_height|r_height]] - '600' - Initial main window width. | ||
Line 47: | Line 46: | ||
: [[CVAR r_vsync|r_vsync]] - '1.0' - If should render each frame one frame synced with device rate. | : [[CVAR r_vsync|r_vsync]] - '1.0' - If should render each frame one frame synced with device rate. | ||
==== Assignments ==== | |||
: none | |||
=== Input module === | |||
==== Commands global ==== | |||
: [[MACRO quit|quit]] - quit, /quit - Exits engine immediately with graceful shutdown. | |||
==== Vars global ==== | |||
: [[CVAR m_sensitivity|m_sensitivity]] - '1.0' - General mouse sensitivity. | |||
: [[CVAR m_raw|m_raw]] - '1' (0,1,2) - 0 off if can, 1 on if can, 2 force on. Windows always on. Off if platform not complete or in a VM. | |||
==== Bindings ==== | |||
: KB_ESC - 'quit' | |||
==== Assignments ==== | ==== Assignments ==== | ||
: none | : none |
Revision as of 23:10, 12 October 2023
This is a reference for Engine console commands available for use a chat window or other console, and as macro commands in a macro.
This list describes all of the 'slash' commands from Engine itself, and not from any additional modules or AddOns.
By default in the core or empty UI, the console can be entered during runtime by pressing the 'back tick' (`) and exited by pressing escape (Esc). If in a chat type box, commands can be run by starting with a forward slash before the command line, to separate them from actual chat.
Reference
In Engine, commands are divided into sets defined by modules. Some commands are always available by default. Others are only available by setting console context to that module first. In some modules, there can be a default command that gets run if no actual command is specified.
Data module
- In context by default
- Default command is 'varedit' if in context
Global commands
- varedit - (none), / - Prints or sets variable, if variable exists and name is not another command.
- var - var, /var - Creates a variable. If already exists, then does not change value.
- set - set, /set - Set an existing var. Updates a value on an existing variable if exists.
- alias - alias, /alias - New named script. Will change existing alias if already created.
- bind - bind, /bind - Key to script. Map a key to a script block.
- echo - echo, /echo - Write text to log only. Print text to current console but not the file.
- print - print, /print - Write text to log and file. Print text to current console and to file.
- context - context, /context - Change context. Change current console context to another known context.
- run - run, /run - Load and run script file. Run a named script file. Name must include extension.
Global vars
- lib_path - './lib/' - Path for native 'world' modules.
- base_path - './data/' - Path for content and assets.
- module - 'game' - Base name for 'world' module, without platform postfix.
- GameDll - (none) - Full path for 'world' module, './lib/gamex86.dll'.
- s_use_ai - '1.0' - If world 'AI' processing is enabled.
- map - 'maps/base1.bsp' - Full path for default content module.
- startup - (none) - Full path of initial startup script.
Assignments
- Explicit context name is 'global'
- Default log assignment is 'log'
- Initial console assignment is 'console'
Render module
Global commands
- none
Global vars
- r_width - '900' - Initial main window height.
- r_height - '600' - Initial main window width.
- r_bpp - '32' - Initial render device color bit depth.
- r_fullscreen - (none) - If device full-screen, without window.
- r_gamma - '1.0' - Device color gamma correction.
- r_vsync - '1.0' - If should render each frame one frame synced with device rate.
Assignments
- none
Input module
Commands global
- quit - quit, /quit - Exits engine immediately with graceful shutdown.
Vars global
- m_sensitivity - '1.0' - General mouse sensitivity.
- m_raw - '1' (0,1,2) - 0 off if can, 1 on if can, 2 force on. Windows always on. Off if platform not complete or in a VM.
Bindings
- KB_ESC - 'quit'
Assignments
- none