Engine:Console commands: Difference between revisions

<!--{{macroapi}}-->

This list describes all of the 'slash' commands from Engine itself, and not from any additional modules or [[AddOn]]s. These same commands are available in the base Engine scripting language.

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.

 

== Key ==

* 'Global commands' and 'Global variables' - below are short-hand for commands placed in the 'global' context.

* 'Default command' - is run by default if its context is addressed by name or is the current context. Examples:

** Will print 3. Where 'lua' is a child context and 'print' is a real Lua command, not an Engine script one. <pre>lua print(1 + 3)</pre>  

** Will also print 3 and return to global. Where context is switched to, then the Lua command is run. <pre>context lua; print(1 + 3); exit</pre>

** Will start the client module. <pre lang="lua">client start</pre>  

** Will start the client module and return to global. <pre>context client; start; context global</pre>

** Will print 'fred', using the 'global' default 'varedit' command. 'bob' is not a command but an existing variable. <pre lang="lua">var bob fred; bob</pre>

** Will print 'james'. Where the default command finds the existing 'bob', and assigns 'james'. <pre lang="lua">bob james; bob</pre>

* Command - a script command

* Variable - a script variable

* Alias - an alias or macro created using the global alias command

* Binding - key bindings to the keyboard or mouse buttons, or other real or virtual device things

* Associations - Module or context associations and features

* Service - here refers to messaging service. Which may be internal, local or through a network for send or receive.

: [[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 set|set]] - set, /set - Set an existing var. Updates a value on an existing variable if exists.

: [[MACRO alias|alias]] - alias, /alias - New named script. Will change existing alias if already created.

: [[MACRO bind|bind]] - bind, /bind - Key to script.  Map a key to a script block.

: [[MACRO echo|echo]] - echo, /echo - Write text to log only. Print text to current console but not the file.

: [[MACRO bind|print]] - print, /print - Write text to log and file. Print text to current console and to file.

: [[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.

: [[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|module]] - 'game' - Base name for 'world' module, without platform postfix.

: [[CVAR lib_path|GameDll]] - (none) - Full path for 'world' module, './lib/gamex86.dll'.

: [[CVAR lib_path|s_use_ai]] - '1.0' - If world 'AI' processing is enabled.

: [[CVAR lib_path|map]] - 'maps/base1.bsp' - Full path for default content module.

: [[CVAR lib_path|startup]] - (none) - Full path of initial startup script.

: Inherits 'global' context

: [[MACRO lua.lua_edit|lua_edit]] - (none), / - Runs a Lua command in the main Lua runtime as though were in a Lua console

: [[MACRO lua.run|run]] - lua run - Runs a Lua command in the Lua runtime.

: [[MACRO lua.block|block]] - lua run - Runs a Lua command block in the Lua runtime

: [[MACRO lua.exit|exit]] - lua exit - Immediately switches current context to 'global'

: [[MACRO quit|quit]] - quit, /quit - Exits engine immediately with graceful shutdown.

: [[MACRO console|console]] - console, /console - Opens command console

: [[MACRO client.start|start]] - client start - Starts the 'client' module.

: [[MACRO client.stop|stop]] - client stop - Stops the 'client' module.

: [[MACRO client.lol|lol]] - client lol - 'print "client lol"' - Demo alias. Prints "client lol".