Spring - User contributions [en]

UI commands

2020-12-19T09:58:51Z

Tulipe: /* 3 commands added */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}
=How to use the console=
The ingame chat is the console. Open with hitting the `<code>return</code>` or `<code>enter</code>` key.
If you want to enter a command into ingame chat, you must add a <code>/</code> in front 
for example: <code>/commandhelp</code> 
Some commands will also autocomplete if you press <code>TAB</code>. So if you enter "/com" and then to press TAB, it will complete it to `/command` and tells you there is `/commandhelp` & `/commandlist`, if you now enter either `l` or `h` and press TAB again it will complete to one of them.

Also commands are not case-sensitive.

=Lists of commands, some are even explained=

For a complete (excluding Lua commands & some engine `actions`) use:
<code>/commandlist</code>

Example output (104.0):
<pre style="overflow:auto; width:auto;">
Chat commands plus description
==============================
/Atm (synced) Gives 1000 metal and 1000 energy to the issuing players team
/Cheat (synced) Enables/Disables cheating, which is required for a lot of other commands to be usable
/Destroy (synced) Destroys one or multiple units by unit-ID, instantly
/DevLua (synced) Enables/Disables Lua dev-mode (can cause desyncs if enabled)
/EditDefs (synced) Allows/Disallows editing of unit-, feature- and weapon-defs through Lua
/Give [amount] <objectName|'all'>(synced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team.
Example: /give 10 corkrog 3 - gives team 3 10 corkrogs.
/GlobalLOS (synced) Enables/Disables global line-of-sight, which makes the whole map permanently visible to everyone or to a specific allyteam
/GodMode (synced) Enables/Disables god-mode, which allows all players (even spectators) to control all units (even during replays, which will DESYNC them)
/LuaGaia (synced) Allows reloading or disabling LuaGaia, and to send a chat message to LuaGaia scripts
/LuaRules (synced) Allows reloading or disabling LuaRules, and to send a chat message to LuaRules scripts
/NoCost (synced) Enables/Disables everything-for-free, which allows everyone to build everything for zero resource costs
/NoHelp (synced) Enables/Disables widgets (LuaUI control)
/NoSpecDraw (synced) Allows/Disallows spectators to draw on the map
/NoSpectatorChat (synced) Enables/Disables spectators to use the chat
/ReloadCEGs (synced) Reloads CEG scripts
/ReloadCOB (synced) Reloads COB scripts
/Skip (synced) Fast-forwards to a given frame, or stops fast-forwarding
/Take (synced) Transfers all units of allied teams without any active players to the team of the issuing player
/AdvMapShading (unsynced) Set or toggle advanced map shading mode
/AdvModelShading (unsynced) Set or toggle advanced model shading mode
/AIControl (unsynced) Creates a new instance of a Skirmish AI, to let it controll a specific team
/AIKill (unsynced) Kills the Skirmish AI controlling a specified team
/AIList (unsynced) Prints a list of all currently active Skirmish AIs
/AIReload (unsynced) Reloads the Skirmish AI controlling a specified team
/AirMesh (unsynced) Show/Hide the smooth air-mesh map overlay
/AllMapMarks (unsynced) Show/Hide all map marks drawn so far
/Ally (unsynced) Starts/Ends alliance of the local players ally-team with another ally-team
/ATM (unsynced) Redirects command /ATM to its synced processor
/BufferText (unsynced) Write the argument string(s) directly to the console history, but not anywhere else. This is useful for fast manual issuing of the command,
later on
/Chat (unsynced) Starts waiting for intput to be sent to
/ChatAll (unsynced) Starts waiting for intput to be sent to All
/ChatAlly (unsynced) Starts waiting for intput to be sent to Ally
/ChatSpec (unsynced) Starts waiting for intput to be sent to Spec
/ClearMapMarks (unsynced) Remove all map marks drawn so far
/Clock (unsynced) Shows a small digital clock indicating the local time
/CmdColors (unsynced) Reloads cmdcolors.txt
/CommandHelp (unsynced) Prints info about a specific chat command (so far only synced/unsynced and the description)
/CommandList (unsynced) Prints all the available chat commands with description (if available) to the console
/Console (unsynced) Enables/Disables the in-game console
/ControlUnit (unsynced) Start to first-person-control a unit
/Crash (unsynced) Invoke an artificial crash through a NULL-pointer dereference (SIGSEGV)
/CreateVideo (unsynced) Start/Stop capturing a video of the game in progress
/Cross (unsynced) Allows one to exchange and modify the appearance of the cross/mouse-pointer in first-person-control view
/CtrlPanel (unsynced) Reloads GUI config
/Debug (unsynced) Enable/Disable debug rendering mode
/DebugColVol (unsynced) Enable/Disable drawing of collision volumes
/DebugDrawAI (unsynced) Enables/Disables debug drawing for AIs
/DebugGL (unsynced) Enable/Disable OpenGL debug-context output
/DebugGLErrors (unsynced) Enable/Disable OpenGL debug-errors
/DebugInfo (unsynced) Print debug info to the chat/log-file about either: sound, profiling
/DebugPath (unsynced) Enable/Disable drawing of pathfinder debug-data
/DebugTraceRay (unsynced) Enable/Disable drawing of traceray debug-data
/DecGUIOpacity (unsynced) Decreases the opacity(see-through-ness) of GUI elements
/DecreaseViewRadius (unsynced) Decrease the view radius (higher performance, uglier view)
/Deselect (unsynced) Deselects all currently selected units
/Destroy (unsynced) Destroys one or multiple units by unit-ID, instantly
/DistDraw (unsynced) Set the distance between units and camera, at which they turn into far-textures (flat/texture-only representation) (Graphic setting)
/DistIcon (unsynced) Set the distance between units and camera, at which they turn into icons (Graphic setting)
/DivByZero (unsynced) Invoke an artificial crash by performing a division-by-Zero
/DrawInMap (unsynced) Enables drawing on the map
/DrawLabel (unsynced) Draws a label on the map at the current mouse-pointer position
/DrawTrees (unsynced) Enable/Disable engine-tree rendering
/DumpState (unsynced) dump game-state to file
/DynamicSky (unsynced) Enable/Disable dynamic-sky rendering
/Echo (unsynced) Write a string to the log file
/EndGraph (unsynced) Enables/Disables the statistics graphs shown at the end of the game
/Exception (unsynced) Invoke an artificial crash by throwing an std::runtime_error
/Font (unsynced) Reloads the fonts
/FPS (unsynced) Shows/Hides the frames-per-second indicator
/FPSHud (unsynced) Enables/Disables HUD (GUI interface) shown in first-person-control mode
/Fullscreen (unsynced) Switches fullscreen mode
/GameInfo (unsynced) Enables/Disables game-info panel rendering
/GatherMode (unsynced) Enter/Leave gather-wait command mode
/Give (unsynced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team
/GrabInput (unsynced) Prevents/Enables the mouse from leaving the game window (windowed mode only)
/GroundDecals (unsynced) Disable/Enable ground-decals rendering. Ground-decals are things like scars appearing on the map after an explosion.
/GroundDetail (unsynced) Set the level of ground detail
/Group (unsynced) Allows modifying the members of a group
/Group0 (unsynced) Allows modifying the members of group 0
/Group1 (unsynced) Allows modifying the members of group 1
/Group2 (unsynced) Allows modifying the members of group 2
/Group3 (unsynced) Allows modifying the members of group 3
/Group4 (unsynced) Allows modifying the members of group 4
/Group5 (unsynced) Allows modifying the members of group 5
/Group6 (unsynced) Allows modifying the members of group 6
/Group7 (unsynced) Allows modifying the members of group 7
/Group8 (unsynced) Allows modifying the members of group 8
/Group9 (unsynced) Allows modifying the members of group 9
/HardwareCursor (unsynced) Enables/Disables hardware mouse-cursor support
/HideInterface (unsynced) Hide/Show the GUI controlls
/IncGUIOpacity (unsynced) Increases the opacity(see-through-ness) of GUI elements
/IncreaseViewRadius (unsynced) Increase the view radius (lower performance, nicer view)
/Info (unsynced) Shows/Hides the player roster
/InputTextGeo (unsynced) Move and/or resize the input-text field (the "Say: " thing)
/LastMsgPos (unsynced) Moves the camera to show the position of the last message
/LessClouds (unsynced) Decreases the density of clouds (higher performance)
/LessTrees (unsynced) Decreases distance from the camera at which trees are still drawn
/LODScale (unsynced) Set the scale for either of: LOD (level-of-detail), shadow-LOD, reflection-LOD, refraction-LOD
/LuaGaia (unsynced) Redirects command /LuaGaia to its synced processor
/LuaRules (unsynced) Redirects command /LuaRules to its synced processor
/LuaSave (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/LuaUI (unsynced) Allows one to reload or disable LuaUI, or alternatively to send a chat message to LuaUI
/MapBorder (unsynced) Set or toggle map-border rendering
/MapMarks (unsynced) Enables/Disables map marks rendering
/mapmeshdrawer (unsynced) Switch map-mesh rendering modes: 0=GCM, 1=HLOD, 2=ROAM
/MapShadowPolyOffset (unsynced)
/MaxNanoParticles (unsynced) Set the maximum number of nano-particles (Graphic setting)
/MaxParticles (unsynced) Set the maximum number of particles (Graphics setting)
/MiniMap (unsynced) FIXME document subcommands. There may be more beyond minimize, maximize and geometry.
/MiniMap Minimize (unsynced) Performs the same action as pressing the red button under the minimap.
/MiniMap Maximize (unsynced) Performs the same action as holding Shift and pressing the yellow button under the minimap, i.e, maintains map aspect ratio.
/MiniMap Geometry X Y W H (unsynced) Sets the size of the minimap. X and Y are the coordinates of the top left corner while W and H are the width and height. Both pairs are in
pixels corresponding to monitor resolution.
/MoreClouds (unsynced) Increases the density of clouds (lower performance)
/MoreTrees (unsynced) Increases distance from the camera at which trees are still drawn
/Mouse1 (unsynced) Simulates a mouse button press of button 1
/Mouse2 (unsynced) Simulates a mouse button press of button 2
/Mouse3 (unsynced) Simulates a mouse button press of button 3
/Mouse4 (unsynced) Simulates a mouse button press of button 4
/Mouse5 (unsynced) Simulates a mouse button press of button 5
/MoveBack (unsynced) Moves the camera Back a bit
/MoveDown (unsynced) Moves the camera Down a bit
/MoveFast (unsynced) Moves the camera Fast a bit
/MoveForward (unsynced) Moves the camera Forward a bit
/MoveLeft (unsynced) Moves the camera Left a bit
/MoveRight (unsynced) Moves the camera Right a bit
/MoveSlow (unsynced) Moves the camera Slow a bit
/MoveUp (unsynced) Moves the camera Up a bit
/MuteSound (unsynced) Mute/Unmute the current sound system
/NoLuaDraw (unsynced) Allow/Disallow Lua to draw on the map
/PasteText (unsynced) Paste either the argument string(s) or if none given, the content of the clip-board to chat input
/Pause (unsynced) Pause/Unpause the game
/QuitForce (unsynced) Exits game to system
/QuitMenu (unsynced) Opens the quit-menu, if it is not already open
/QuitMessage (unsynced) Deprecated, see /Quit instead (was used to quite the game immediately)
/ReloadForce (unsynced) Exits game to menu
/ReloadGame (unsynced) Restarts the game with the initially provided start-script
/ReloadShaders (unsynced) Reloads all engine shaders
/ResBar (unsynced) Shows/Hides team resource storage indicator bar
/Resync (unsynced) Redirects command /Resync to its synced processor
/SafeGL (unsynced) Enables/Disables OpenGL safe-mode
/Save (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/SaveGame (unsynced) Save the game state to QuickSave.ssf (BROKEN)
/Say (unsynced) Say something in (public) chat
/ScreenShot (unsynced) Take a low quality JPG screen-shot of the current view
/ScreenShot png (unsynced) Take a high quality PNG screen-shot of the current view
/Select (unsynced) <chat command description: Select>
/SelectCycle (unsynced) <chat command description: SelectUnits>
/SelectUnits (unsynced) <chat command description: SelectUnits>
/Send (unsynced) Send a string as raw network message to the game host (for debugging only)
/Set (unsynced) Set a config key=value pair
/Shadows (unsynced) Disables/Enables shadows rendering: -1=disabled, 0=off, 1=full shadows, 2=skip terrain shadows
/ShareDialog (unsynced) Opens the share dialog, which allows you to send units and resources to other players
/ShowElevation (unsynced) Enable rendering of the auxiliary height-map overlay
/ShowMetalMap (unsynced) Enable rendering of the auxiliary metal-map overlay
/ShowPathCost (unsynced) Enable rendering of the path cost-map overlay
/ShowPathFlow (unsynced) Enable/Disable rendering of the path flow-map overlay
/ShowPathHeat (unsynced) Enable/Disable rendering of the path heat-map overlay
/ShowPathTraversability (unsynced) Enable rendering of the path traversability-map overlay
/ShowPathType (unsynced) Shows path traversability for a given MoveDefName, MoveDefID or UnitDefName
/ShowStandard (unsynced) Disable rendering of all auxiliary map overlays
/SlowDown (unsynced) Decreases the simulation speed. The engine will try to simulate less frames per second
/SoundChannelEnable (unsynced) Enable/Disable specific sound channels: UnitReply, General, Battle, UserInterface, Music
/SoundDevice (unsynced) Switch the sound output system (currently only OpenAL / NullAudio)
/SpecFullView (unsynced) Sets or toggles between full LOS or ally-team LOS, if the local user is a spectator
/Spectator (unsynced) Lets the local user give up control over a team, and start spectating
/SpecTeam (unsynced) Lets the local user specify the team to follow, if he is a spectator
/Speed (unsynced) Shows/Hides the simulation speed indicator
/SpeedControl (unsynced) Sets how server adjusts speed according to player's load (CPU), 1: use average, 2: use highest,
/SpeedUp (unsynced) Increases the simulation speed. The engine will try to simulate more frames per second
/Take (unsynced) Redirects command /Take to its synced processor
/Team (unsynced) Lets the local user change to another team
/TeamHighlight (unsynced) Enables/Disables uncontrolled team blinking
/ToggleInfo (unsynced) Toggles current info texture view
/ToggleLOS (unsynced) Enable rendering of the auxiliary LOS-map overlay
/ToolTip (unsynced) Enables/Disables the general tool-tips, displayed when hovering over units. features or the map
/Track (unsynced) Start following the selected unit(s) with the camera
/TrackMode (unsynced) Shift through different ways of following selected unit(s)
/TrackOff (unsynced) Stop following the selected unit(s) with the camera
/TSet (unsynced) Set a config key=value pair in the overlay, meaning it will not be persisted for future games
/ViewSelection (unsynced) Moves the camera to the center of the currently selected units
/VSync (unsynced) Enables/Disables vertical-sync (Graphics setting)
/W (unsynced) Say something in private to a specific player, by player-name
/Water (unsynced) Set water rendering mode: 0=basic, 1=reflective, 2=dynamic, 3=reflective&refractive, 4=bump-mapped
/WByNum (unsynced) Say something in private to a specific player, by player-ID
/WireMap (unsynced) Toggle wireframe-mode drawing of map geometry
/WireModel (unsynced) Toggle wireframe-mode drawing of model geometry
/WireSky (unsynced) Toggle wireframe-mode drawing of skydome geometry
/WireTree (unsynced) Toggle wireframe-mode drawing of tree geometry
/WireWater (unsynced) Toggle wireframe-mode drawing of water geometry
</pre>
More commands:
<pre style="overflow:auto; width:auto;">
/bind <keyset> <action> Binds a key or key combination. Example with a key: /bind a reclaim. Example with a "key combination": /bind ctrl+a reclaim
/luarules halfhealth Give to all units half health
/luarules loadmissiles Load tacnuks, junos etc, to their max stockpile
/luagaia reload Reloads gaia gadgets
/luarules reload Reloads gadgets
/luaui reload
/luaui tweakgui Tweak mode on
/luaui selector Open the default widget selector (similar to pressing F11).
/options Open the options interface for some games and mods
/Setmaxspeed # Changes the maximum speed (default is 3.0)
/Setminspeed # Changes the minimum speed (default is 0.3)
/unbind <keyset> <action> Unbinds a key or key combination. Example: /unbind a reclaim.
/unbindaction <action> Unbinds all keybinds that uses <action>.
/unbindkeyset <keyset> Unbinds all bindings that uses <keyset>.
/unbindall Unbinds all keys except the chat keybinding.

</pre>

=Scripting=
In Lua scripts, these commands can be used like this: 
Spring.SendCommands("resbar 0") 
notice the missing / when used like this. 

[[Category:Help]]

Building Spring on Windows

2020-07-22T13:53:56Z

Tulipe: Another way added to fix some problems.

[[Engine_Development|Development]] < [[Building_spring|Building Spring]] < {{FULLPAGENAME}}
{{#css:
code * {margin:inherit;}
}}

If you only want to produce your own Spring game and not contribute to the core engine, compilation is not necessary. Check out [[Gamedev:Main]].

Warning: Compiling Spring on Windows often causes problems, it is heavily recommended to use [[Building_Spring_on_Linux|Linux]] for developing the Spring RTS Engine if possible.

Some reasons for this:
* Of the active developers nobody uses windows for developing. So they might not be able to help as effectively as on Linux.
* Setting up a build environment takes a lot more time on windows
* Compiling is often slower on windows
* Compiling on windows is poorly tested (which possibly leads to some random / unknown / weird errors)

That said, if you do wish to use Windows, the best place to get real-time help is the #sy lobby channel, or #sy on [[IRC]].

=Compiling with MinGW=

== Requirements ==
Install [http://www.cmake.org/ CMake] and [http://msysgit.github.io/ msysGit] and MinGW-w64:

When installing msysGit you should select the option to "Run Git from the Windows Command Prompt":

[[File:Msysgit6.png|400px]]

This is in order to automatically add Git to PATH making it easy for CMake to find.

== Installing MinGW-w64 ==

Download and run the "Mingw-builds project - native toolchains using trunk" installer from [http://mingw-w64.org/doku.php/download/mingw-builds], more specifically from here: [https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win32/Personal%20Builds/mingw-builds/installer/mingw-w64-install.exe/download]

Select the following options:

[[File:InstallingMinGW-w64.png|400px]]

* '''Version:''' Any version above 4.8.x should work, 4.9.x+ may not have been tested as thoroughly. In 2020, version 8.1.0 works fine!
* '''Architecture:''' i686
* '''Threads:''' posix
* '''Exception:''' sjlj This is the only setting which needs to be changed from the default
* '''Build Revision:''' The latest one

== Adding to PATH ==

Once installed, you should add the MinGW directory to your PATH variable so that Cmake can find the relevant binaries.

* Go to System properties (either via Control Panel\System and Security\System or by right clicking 'Computer' on the desktop), then click 'Advanced System Settings'.
* Click the 'Environment Variables' button at the bottom.
* Find Path in the 'System Variables' scrollbox, add an extra <code>;</code> to the end and then copy-paste in the MinGW directory (e.g. default is <code>C:\Program Files (x86)\mingw-w64\i686-4.9.1-posix-sjlj-rt_v3-rev0\mingw32\bin</code>).
* Alternative instructions with images are easy to find online, for example [http://geekswithblogs.net/renso/archive/2009/10/21/how-to-set-the-windows-path-in-windows-7.aspx here].

= Get the Source Code =

* use git's bash (you find it in the right click context menu when clicking the folder), <code>cd</code> into your spring source dir

<code><pre>
git clone --recursive git://github.com/spring/spring.git -b develop
cd spring
git clone https://github.com/spring/mingwlibs
</pre></code>

* update it from time to time with: <code>git pull --rebase</code>

* Make sure you install the package in the checkout directory, so the path is: /spring/mingwlibs. If done right, it will look like:
** */spring/
** */spring/...
** */spring/mingwlibs
** */spring/rts

* Note: if you install the package somewhere else (preferably outside of the source tree), and pass its location with the ''MINGDIR'' option to CMake in the configure step (see further down, in the quick instructions).

== configure using CMake ==

Note, as of 2020, cmake-3.10.1-win64-x64.msi from https://cmake.org/files/v3.10/ works, 3.18 has issues detecting zlib.

* run the ''cmake-gui'' and select a source and a build directory
* press '''Configure''' and follow the instructions
* specify native compilers by entering the paths to gcc.exe and g++.exe from your mingw64-builds directory
* if you wish to build the full portable version (install-spring), then make sure to set the CMAKE_INSTALL_PREFIX as well
* In case of configuration errors make sure AI_TYPES variable is set to NONE (default is ALL). This should remedy the issues press '''Configure''' again (Remark: Setting NATIVE works as well (tested in commit 9108cae116))
* This is where you can specify the build type, REL for release, DEBUG for debug build, and RELWITHDEBINFO for a mix
* press '''Generate'''
* open a console (''cmd.exe''), ''cd'' into your '''build''' directory
* ''optional:'' for multi-threaded compilation, the ''mingw32-make'' part may differ on your system: <code>''<pre>set MAKE_COMMAND=mingw32-make -j2</pre>''</code> (use -j4 for 4 threads). For codeblocks configure CMAKE_CODEBLOCKS_MAKE_ARGUMENTS as -j4
* compile with: <code>''<pre>mingw32-make install-spring</pre>''</code>
* compile just the engine (spring.exe) with: <code>''<pre>mingw32-make engine-legacy</pre>''</code>

===Generating the AI Sources/Wrappers===

you can either build the wrapper:

<code>make Cpp-AIWrapper</code>

or generate all sources, in case you don't need the binary:

<code>make generateSources</code>

===Possible Problems===
* If you have successfully compiled but don't have an ingame graphical user interface and no widgets working, you could try downloading and compiling from the maintenance branch instead develop.
<code>
git clone --recursive git://github.com/spring/spring.git -b maintenance
</code>

* If you get undefined reference to `_Unwind_Resume' linking errors, deinstall ''whole'' MinGW and reinstall it with ''sjlj''.

* When you installed an old version of MinGW/TDM and forgot to deinstall it correctly, <code>gcc.exe</code> & <code>g++.exe</code> will be named <code>gcc-dw2.exe</code>/<code>g++-dw2.exe</code>. CMake will then fail to find the correct one, first try to deinstall anything mingw related and reinstall everything. If that didn't helped just rename the files. If even that doesn't help open cmake-gui and click the advanced button and set the paths to the correct files yourself (<code>CMAKE_C_COMPILER</code> & <code>CMAKE_CXX_COMPILER</code>).

=== Notes ===

You can still use Visual Studio 2012 as described below to edit the code. This is very useful because it allows excellent code navigation, and it highlights syntax errors and trivial mistakes before compiling.

For debugging mingw builds, you can aquire a windows build of gdb from http://www.equation.com/servlet/equation.cmd?fa=gdb

To start debugging, copy ''gdb.exe'' to your build output directory, and launch it with ''gdb spring.exe''. You can supply command line arguments to ''spring.exe'' with ''gdb --args spring.exe myreplayfile.sdf''

=Compiling with Visual Studio (not officially supported!)=
Currently Visual Studio lacks some c++ features it doesn't compile spring!

==General Visual Studio Notes==
When developing using Visual Studio keep in mind:
*It's experimental and not proved to compile or run!
*Your VS build won't sync with GCC builds in multiplayer mode
*AIs built with Visual Studio will work with the mingw32 release builds thanks to the C AI Interface, however this interface may change when newer releases are made
*Running any non-LUA AI on VS built Spring will crash it

===2012 (v11)===

Install [http://www.microsoft.com/visualstudio/eng/downloads#d-express-windows-desktop Visual Studio 2012 Express for Windows Desktop], [http://www.microsoft.com/en-us/download/confirmation.aspx?id=35515 Visual C++ Compiler November 2012 CTP], [http://www.cmake.org/ cmake], [http://www.7-zip.org 7-zip] and [http://msysgit.github.io/ msysgit].

From the Startmenu run "VS2012 x86 Native Tools Command Prompt" and type:

<code><pre>
set PATH=%PATH%;%PROGRAMFILES%\git\bin;%PROGRAMFILES%\cmake 2.8\bin\
git clone --recursive git://github.com/spring/spring.git -b develop
cd spring
git clone git://github.com/spring/vclibs11.git vclibs
cmake -G "Visual Studio 11" .
</pre></code>

Now start visual studio & open Spring.sln. Select "engine-legacy" as default project, as AIs and ofter stuff are known to fail to compile on visual studio.

In the Project Properties, make sure to [http://stackoverflow.com/questions/13238408/variadic-template-in-vs-2012-visual-c-november-2012-ctp select the Microsoft Visual C++ Compiler Nov 2012 CTP].

Note: Visual Studio 2012 Express for Windows Desktop is for free, but requires a registration after 30 days (to get a free license).

[[Category:Compiling]]

UI commands

2019-10-04T16:10:16Z

Tulipe: /* "the the" remplaced by "the" and some changes for the description of "/bind" command*/

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}
=How to use the console=
The ingame chat is the console. Open with hitting the `<code>return</code>` or `<code>enter</code>` key.
If you want to enter a command into ingame chat, you must add a <code>/</code> in front 
for example: <code>/commandhelp</code> 
Some commands will also autocomplete if you press <code>TAB</code>. So if you enter "/com" and then to press TAB, it will complete it to `/command` and tells you there is `/commandhelp` & `/commandlist`, if you now enter either `l` or `h` and press TAB again it will complete to one of them.

Also commands are not case-sensitive.

=Lists of commands, some are even explained=

For a complete (excluding Lua commands & some engine `actions`) use:
<code>/commandlist</code>

Example output (104.0):
<pre style="overflow:auto; width:auto;">
Chat commands plus description
==============================
/Atm (synced) Gives 1000 metal and 1000 energy to the issuing players team
/Cheat (synced) Enables/Disables cheating, which is required for a lot of other commands to be usable
/Destroy (synced) Destroys one or multiple units by unit-ID, instantly
/DevLua (synced) Enables/Disables Lua dev-mode (can cause desyncs if enabled)
/EditDefs (synced) Allows/Disallows editing of unit-, feature- and weapon-defs through Lua
/Give [amount] <objectName|'all'>(synced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team. Example : /give 10 corkrog 3 - gives team 3 10 corkrogs.
/GlobalLOS (synced) Enables/Disables global line-of-sight, which makes the whole map permanently visible to everyone or to a specific allyteam
/GodMode (synced) Enables/Disables god-mode, which allows all players (even spectators) to control all units (even during replays, which will DESYNC them)
/LuaGaia (synced) Allows reloading or disabling LuaGaia, and to send a chat message to LuaGaia scripts
/LuaRules (synced) Allows reloading or disabling LuaRules, and to send a chat message to LuaRules scripts
/NoCost (synced) Enables/Disables everything-for-free, which allows everyone to build everything for zero resource costs
/NoHelp (synced) Enables/Disables widgets (LuaUI control)
/NoSpecDraw (synced) Allows/Disallows spectators to draw on the map
/NoSpectatorChat (synced) Enables/Disables spectators to use the chat
/ReloadCEGs (synced) Reloads CEG scripts
/ReloadCOB (synced) Reloads COB scripts
/Skip (synced) Fast-forwards to a given frame, or stops fast-forwarding
/Take (synced) Transfers all units of allied teams without any active players to the team of the issuing player
/AdvMapShading (unsynced) Set or toggle advanced map shading mode
/AdvModelShading (unsynced) Set or toggle advanced model shading mode
/AIControl (unsynced) Creates a new instance of a Skirmish AI, to let it controll a specific team
/AIKill (unsynced) Kills the Skirmish AI controlling a specified team
/AIList (unsynced) Prints a list of all currently active Skirmish AIs
/AIReload (unsynced) Reloads the Skirmish AI controlling a specified team
/AirMesh (unsynced) Show/Hide the smooth air-mesh map overlay
/AllMapMarks (unsynced) Show/Hide all map marks drawn so far
/Ally (unsynced) Starts/Ends alliance of the local players ally-team with another ally-team
/ATM (unsynced) Redirects command /ATM to its synced processor
/BufferText (unsynced) Write the argument string(s) directly to the console history, but not anywhere else. This is useful for fast manual issuing of the command, later on
/Chat (unsynced) Starts waiting for intput to be sent to
/ChatAll (unsynced) Starts waiting for intput to be sent to All
/ChatAlly (unsynced) Starts waiting for intput to be sent to Ally
/ChatSpec (unsynced) Starts waiting for intput to be sent to Spec
/ClearMapMarks (unsynced) Remove all map marks drawn so far
/Clock (unsynced) Shows a small digital clock indicating the local time
/CmdColors (unsynced) Reloads cmdcolors.txt
/CommandHelp (unsynced) Prints info about a specific chat command (so far only synced/unsynced and the description)
/CommandList (unsynced) Prints all the available chat commands with description (if available) to the console
/Console (unsynced) Enables/Disables the in-game console
/ControlUnit (unsynced) Start to first-person-control a unit
/Crash (unsynced) Invoke an artificial crash through a NULL-pointer dereference (SIGSEGV)
/CreateVideo (unsynced) Start/Stop capturing a video of the game in progress
/Cross (unsynced) Allows one to exchange and modify the appearance of the cross/mouse-pointer in first-person-control view
/CtrlPanel (unsynced) Reloads GUI config
/Debug (unsynced) Enable/Disable debug rendering mode
/DebugColVol (unsynced) Enable/Disable drawing of collision volumes
/DebugDrawAI (unsynced) Enables/Disables debug drawing for AIs
/DebugGL (unsynced) Enable/Disable OpenGL debug-context output
/DebugGLErrors (unsynced) Enable/Disable OpenGL debug-errors
/DebugInfo (unsynced) Print debug info to the chat/log-file about either: sound, profiling
/DebugPath (unsynced) Enable/Disable drawing of pathfinder debug-data
/DebugTraceRay (unsynced) Enable/Disable drawing of traceray debug-data
/DecGUIOpacity (unsynced) Decreases the opacity(see-through-ness) of GUI elements
/DecreaseViewRadius (unsynced) Decrease the view radius (higher performance, uglier view)
/Deselect (unsynced) Deselects all currently selected units
/Destroy (unsynced) Destroys one or multiple units by unit-ID, instantly
/DistDraw (unsynced) Set the distance between units and camera, at which they turn into far-textures (flat/texture-only representation) (Graphic setting)
/DistIcon (unsynced) Set the distance between units and camera, at which they turn into icons (Graphic setting)
/DivByZero (unsynced) Invoke an artificial crash by performing a division-by-Zero
/DrawInMap (unsynced) Enables drawing on the map
/DrawLabel (unsynced) Draws a label on the map at the current mouse-pointer position
/DrawTrees (unsynced) Enable/Disable engine-tree rendering
/DumpState (unsynced) dump game-state to file
/DynamicSky (unsynced) Enable/Disable dynamic-sky rendering
/Echo (unsynced) Write a string to the log file
/EndGraph (unsynced) Enables/Disables the statistics graphs shown at the end of the game
/Exception (unsynced) Invoke an artificial crash by throwing an std::runtime_error
/Font (unsynced) Reloads the fonts
/FPS (unsynced) Shows/Hides the frames-per-second indicator
/FPSHud (unsynced) Enables/Disables HUD (GUI interface) shown in first-person-control mode
/Fullscreen (unsynced) Switches fullscreen mode
/GameInfo (unsynced) Enables/Disables game-info panel rendering
/GatherMode (unsynced) Enter/Leave gather-wait command mode
/Give (unsynced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team
/GrabInput (unsynced) Prevents/Enables the mouse from leaving the game window (windowed mode only)
/GroundDecals (unsynced) Disable/Enable ground-decals rendering. Ground-decals are things like scars appearing on the map after an explosion.
/GroundDetail (unsynced) Set the level of ground detail
/Group (unsynced) Allows modifying the members of a group
/Group0 (unsynced) Allows modifying the members of group 0
/Group1 (unsynced) Allows modifying the members of group 1
/Group2 (unsynced) Allows modifying the members of group 2
/Group3 (unsynced) Allows modifying the members of group 3
/Group4 (unsynced) Allows modifying the members of group 4
/Group5 (unsynced) Allows modifying the members of group 5
/Group6 (unsynced) Allows modifying the members of group 6
/Group7 (unsynced) Allows modifying the members of group 7
/Group8 (unsynced) Allows modifying the members of group 8
/Group9 (unsynced) Allows modifying the members of group 9
/HardwareCursor (unsynced) Enables/Disables hardware mouse-cursor support
/HideInterface (unsynced) Hide/Show the GUI controlls
/IncGUIOpacity (unsynced) Increases the opacity(see-through-ness) of GUI elements
/IncreaseViewRadius (unsynced) Increase the view radius (lower performance, nicer view)
/Info (unsynced) Shows/Hides the player roster
/InputTextGeo (unsynced) Move and/or resize the input-text field (the "Say: " thing)
/LastMsgPos (unsynced) Moves the camera to show the position of the last message
/LessClouds (unsynced) Decreases the density of clouds (higher performance)
/LessTrees (unsynced) Decreases distance from the camera at which trees are still drawn
/LODScale (unsynced) Set the scale for either of: LOD (level-of-detail), shadow-LOD, reflection-LOD, refraction-LOD
/LuaGaia (unsynced) Redirects command /LuaGaia to its synced processor
/LuaRules (unsynced) Redirects command /LuaRules to its synced processor
/LuaSave (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/LuaUI (unsynced) Allows one to reload or disable LuaUI, or alternatively to send a chat message to LuaUI
/MapBorder (unsynced) Set or toggle map-border rendering
/MapMarks (unsynced) Enables/Disables map marks rendering
/mapmeshdrawer (unsynced) Switch map-mesh rendering modes: 0=GCM, 1=HLOD, 2=ROAM
/MapShadowPolyOffset (unsynced)
/MaxNanoParticles (unsynced) Set the maximum number of nano-particles (Graphic setting)
/MaxParticles (unsynced) Set the maximum number of particles (Graphics setting)
/MiniMap (unsynced) FIXME document subcommands
/MoreClouds (unsynced) Increases the density of clouds (lower performance)
/MoreTrees (unsynced) Increases distance from the camera at which trees are still drawn
/Mouse1 (unsynced) Simulates a mouse button press of button 1
/Mouse2 (unsynced) Simulates a mouse button press of button 2
/Mouse3 (unsynced) Simulates a mouse button press of button 3
/Mouse4 (unsynced) Simulates a mouse button press of button 4
/Mouse5 (unsynced) Simulates a mouse button press of button 5
/MoveBack (unsynced) Moves the camera Back a bit
/MoveDown (unsynced) Moves the camera Down a bit
/MoveFast (unsynced) Moves the camera Fast a bit
/MoveForward (unsynced) Moves the camera Forward a bit
/MoveLeft (unsynced) Moves the camera Left a bit
/MoveRight (unsynced) Moves the camera Right a bit
/MoveSlow (unsynced) Moves the camera Slow a bit
/MoveUp (unsynced) Moves the camera Up a bit
/MuteSound (unsynced) Mute/Unmute the current sound system
/NoLuaDraw (unsynced) Allow/Disallow Lua to draw on the map
/PasteText (unsynced) Paste either the argument string(s) or if none given, the content of the clip-board to chat input
/Pause (unsynced) Pause/Unpause the game
/QuitForce (unsynced) Exits game to system
/QuitMenu (unsynced) Opens the quit-menu, if it is not already open
/QuitMessage (unsynced) Deprecated, see /Quit instead (was used to quite the game immediately)
/ReloadForce (unsynced) Exits game to menu
/ReloadGame (unsynced) Restarts the game with the initially provided start-script
/ReloadShaders (unsynced) Reloads all engine shaders
/ResBar (unsynced) Shows/Hides team resource storage indicator bar
/Resync (unsynced) Redirects command /Resync to its synced processor
/SafeGL (unsynced) Enables/Disables OpenGL safe-mode
/Save (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/SaveGame (unsynced) Save the game state to QuickSave.ssf (BROKEN)
/Say (unsynced) Say something in (public) chat
/ScreenShot (unsynced) Take a screen-shot of the current view
/Select (unsynced) <chat command description: Select>
/SelectCycle (unsynced) <chat command description: SelectUnits>
/SelectUnits (unsynced) <chat command description: SelectUnits>
/Send (unsynced) Send a string as raw network message to the game host (for debugging only)
/Set (unsynced) Set a config key=value pair
/Shadows (unsynced) Disables/Enables shadows rendering: -1=disabled, 0=off, 1=full shadows, 2=skip terrain shadows
/ShareDialog (unsynced) Opens the share dialog, which allows you to send units and resources to other players
/ShowElevation (unsynced) Enable rendering of the auxiliary height-map overlay
/ShowMetalMap (unsynced) Enable rendering of the auxiliary metal-map overlay
/ShowPathCost (unsynced) Enable rendering of the path cost-map overlay
/ShowPathFlow (unsynced) Enable/Disable rendering of the path flow-map overlay
/ShowPathHeat (unsynced) Enable/Disable rendering of the path heat-map overlay
/ShowPathTraversability (unsynced) Enable rendering of the path traversability-map overlay
/ShowPathType (unsynced) Shows path traversability for a given MoveDefName, MoveDefID or UnitDefName
/ShowStandard (unsynced) Disable rendering of all auxiliary map overlays
/SlowDown (unsynced) Decreases the simulation speed. The engine will try to simulate less frames per second
/SoundChannelEnable (unsynced) Enable/Disable specific sound channels: UnitReply, General, Battle, UserInterface, Music
/SoundDevice (unsynced) Switch the sound output system (currently only OpenAL / NullAudio)
/SpecFullView (unsynced) Sets or toggles between full LOS or ally-team LOS, if the local user is a spectator
/Spectator (unsynced) Lets the local user give up control over a team, and start spectating
/SpecTeam (unsynced) Lets the local user specify the team to follow, if he is a spectator
/Speed (unsynced) Shows/Hides the simulation speed indicator
/SpeedControl (unsynced) Sets how server adjusts speed according to player's load (CPU), 1: use average, 2: use highest,
/SpeedUp (unsynced) Increases the simulation speed. The engine will try to simulate more frames per second
/Take (unsynced) Redirects command /Take to its synced processor
/Team (unsynced) Lets the local user change to another team
/TeamHighlight (unsynced) Enables/Disables uncontrolled team blinking
/ToggleInfo (unsynced) Toggles current info texture view
/ToggleLOS (unsynced) Enable rendering of the auxiliary LOS-map overlay
/ToolTip (unsynced) Enables/Disables the general tool-tips, displayed when hovering over units. features or the map
/Track (unsynced) Start following the selected unit(s) with the camera
/TrackMode (unsynced) Shift through different ways of following selected unit(s)
/TrackOff (unsynced) Stop following the selected unit(s) with the camera
/TSet (unsynced) Set a config key=value pair in the overlay, meaning it will not be persisted for future games
/ViewSelection (unsynced) Moves the camera to the center of the currently selected units
/VSync (unsynced) Enables/Disables vertical-sync (Graphics setting)
/W (unsynced) Say something in private to a specific player, by player-name
/Water (unsynced) Set water rendering mode: 0=basic, 1=reflective, 2=dynamic, 3=reflective&refractive, 4=bump-mapped
/WByNum (unsynced) Say something in private to a specific player, by player-ID
/WireMap (unsynced) Toggle wireframe-mode drawing of map geometry
/WireModel (unsynced) Toggle wireframe-mode drawing of model geometry
/WireSky (unsynced) Toggle wireframe-mode drawing of skydome geometry
/WireTree (unsynced) Toggle wireframe-mode drawing of tree geometry
/WireWater (unsynced) Toggle wireframe-mode drawing of water geometry
</pre>
More commands:
<pre style="overflow:auto; width:auto;">
/bind <keyset> <action> Binds a key or key combination. Example with a key: /bind a reclaim. Example with a "key combination": /bind ctrl+a reclaim
/luagaia reload Reloads gaia gadgets
/luarules reload Reloads gadgets
/luaui reload
/luaui tweakgui Tweak mode on
/Setmaxspeed # Changes the maximum speed (default is 3.0)
/Setminspeed # Changes the minimum speed (default is 0.3)
/unbind <keyset> <action> Unbinds a key or key combination. Example: /unbind a reclaim.
/unbindaction <action> Unbinds all keybinds that uses <action>.
/unbindkeyset <keyset> Unbinds all bindings that uses <keyset>.
/unbindall Unbinds all keys except the chat keybinding.
</pre>

=Scripting=
In Lua scripts, these commands can be used like this: 
Spring.SendCommands("resbar 0") 
notice the missing / when used like this. 

[[Category:Help]]

UI commands

2019-10-01T11:14:47Z

Tulipe: /* Spelling of a title */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}
=How to use the console=
The ingame chat is the console. Open with hitting the `<code>return</code>` or `<code>enter</code>` key.
If you want to enter a command into ingame chat, you must add a <code>/</code> in front 
for example: <code>/commandhelp</code> 
Some commands will also autocomplete if you press <code>TAB</code>. So if you enter "/com" and then to press TAB, it will complete it to `/command` and tells you there is `/commandhelp` & `/commandlist`, if you now enter either `l` or `h` and press TAB again it will complete to one of them.

Also commands are not case-sensitive.

=Lists of commands, some are even explained=

For a complete (excluding Lua commands & some engine `actions`) use:
<code>/commandlist</code>

Example output (104.0):
<pre style="overflow:auto; width:auto;">
Chat commands plus description
==============================
/Atm (synced) Gives 1000 metal and 1000 energy to the issuing players team
/Cheat (synced) Enables/Disables cheating, which is required for a lot of other commands to be usable
/Destroy (synced) Destroys one or multiple units by unit-ID, instantly
/DevLua (synced) Enables/Disables Lua dev-mode (can cause desyncs if enabled)
/EditDefs (synced) Allows/Disallows editing of unit-, feature- and weapon-defs through Lua
/Give [amount] <objectName|'all'>(synced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team. Example : /give 10 corkrog 3 - gives team 3 10 corkrogs.
/GlobalLOS (synced) Enables/Disables global line-of-sight, which makes the whole map permanently visible to everyone or to a specific allyteam
/GodMode (synced) Enables/Disables god-mode, which allows all players (even spectators) to control all units (even during replays, which will DESYNC them)
/LuaGaia (synced) Allows reloading or disabling LuaGaia, and to send a chat message to LuaGaia scripts
/LuaRules (synced) Allows reloading or disabling LuaRules, and to send a chat message to LuaRules scripts
/NoCost (synced) Enables/Disables everything-for-free, which allows everyone to build everything for zero resource costs
/NoHelp (synced) Enables/Disables widgets (LuaUI control)
/NoSpecDraw (synced) Allows/Disallows spectators to draw on the map
/NoSpectatorChat (synced) Enables/Disables spectators to use the chat
/ReloadCEGs (synced) Reloads CEG scripts
/ReloadCOB (synced) Reloads COB scripts
/Skip (synced) Fast-forwards to a given frame, or stops fast-forwarding
/Take (synced) Transfers all units of allied teams without any active players to the team of the issuing player
/AdvMapShading (unsynced) Set or toggle advanced map shading mode
/AdvModelShading (unsynced) Set or toggle advanced model shading mode
/AIControl (unsynced) Creates a new instance of a Skirmish AI, to let it controll a specific team
/AIKill (unsynced) Kills the Skirmish AI controlling a specified team
/AIList (unsynced) Prints a list of all currently active Skirmish AIs
/AIReload (unsynced) Reloads the Skirmish AI controlling a specified team
/AirMesh (unsynced) Show/Hide the smooth air-mesh map overlay
/AllMapMarks (unsynced) Show/Hide all map marks drawn so far
/Ally (unsynced) Starts/Ends alliance of the local players ally-team with another ally-team
/ATM (unsynced) Redirects command /ATM to its synced processor
/BufferText (unsynced) Write the argument string(s) directly to the console history, but not anywhere else. This is useful for fast manual issuing of the command, later on
/Chat (unsynced) Starts waiting for intput to be sent to
/ChatAll (unsynced) Starts waiting for intput to be sent to All
/ChatAlly (unsynced) Starts waiting for intput to be sent to Ally
/ChatSpec (unsynced) Starts waiting for intput to be sent to Spec
/ClearMapMarks (unsynced) Remove all map marks drawn so far
/Clock (unsynced) Shows a small digital clock indicating the local time
/CmdColors (unsynced) Reloads cmdcolors.txt
/CommandHelp (unsynced) Prints info about a specific chat command (so far only synced/unsynced and the description)
/CommandList (unsynced) Prints all the available chat commands with description (if available) to the console
/Console (unsynced) Enables/Disables the in-game console
/ControlUnit (unsynced) Start to first-person-control a unit
/Crash (unsynced) Invoke an artificial crash through a NULL-pointer dereference (SIGSEGV)
/CreateVideo (unsynced) Start/Stop capturing a video of the game in progress
/Cross (unsynced) Allows one to exchange and modify the appearance of the cross/mouse-pointer in first-person-control view
/CtrlPanel (unsynced) Reloads GUI config
/Debug (unsynced) Enable/Disable debug rendering mode
/DebugColVol (unsynced) Enable/Disable drawing of collision volumes
/DebugDrawAI (unsynced) Enables/Disables debug drawing for AIs
/DebugGL (unsynced) Enable/Disable OpenGL debug-context output
/DebugGLErrors (unsynced) Enable/Disable OpenGL debug-errors
/DebugInfo (unsynced) Print debug info to the chat/log-file about either: sound, profiling
/DebugPath (unsynced) Enable/Disable drawing of pathfinder debug-data
/DebugTraceRay (unsynced) Enable/Disable drawing of traceray debug-data
/DecGUIOpacity (unsynced) Decreases the the opacity(see-through-ness) of GUI elements
/DecreaseViewRadius (unsynced) Decrease the view radius (higher performance, uglier view)
/Deselect (unsynced) Deselects all currently selected units
/Destroy (unsynced) Destroys one or multiple units by unit-ID, instantly
/DistDraw (unsynced) Set the distance between units and camera, at which they turn into far-textures (flat/texture-only representation) (Graphic setting)
/DistIcon (unsynced) Set the distance between units and camera, at which they turn into icons (Graphic setting)
/DivByZero (unsynced) Invoke an artificial crash by performing a division-by-Zero
/DrawInMap (unsynced) Enables drawing on the map
/DrawLabel (unsynced) Draws a label on the map at the current mouse-pointer position
/DrawTrees (unsynced) Enable/Disable engine-tree rendering
/DumpState (unsynced) dump game-state to file
/DynamicSky (unsynced) Enable/Disable dynamic-sky rendering
/Echo (unsynced) Write a string to the log file
/EndGraph (unsynced) Enables/Disables the statistics graphs shown at the end of the game
/Exception (unsynced) Invoke an artificial crash by throwing an std::runtime_error
/Font (unsynced) Reloads the fonts
/FPS (unsynced) Shows/Hides the frames-per-second indicator
/FPSHud (unsynced) Enables/Disables HUD (GUI interface) shown in first-person-control mode
/Fullscreen (unsynced) Switches fullscreen mode
/GameInfo (unsynced) Enables/Disables game-info panel rendering
/GatherMode (unsynced) Enter/Leave gather-wait command mode
/Give (unsynced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team
/GrabInput (unsynced) Prevents/Enables the mouse from leaving the game window (windowed mode only)
/GroundDecals (unsynced) Disable/Enable ground-decals rendering. Ground-decals are things like scars appearing on the map after an explosion.
/GroundDetail (unsynced) Set the level of ground detail
/Group (unsynced) Allows modifying the members of a group
/Group0 (unsynced) Allows modifying the members of group 0
/Group1 (unsynced) Allows modifying the members of group 1
/Group2 (unsynced) Allows modifying the members of group 2
/Group3 (unsynced) Allows modifying the members of group 3
/Group4 (unsynced) Allows modifying the members of group 4
/Group5 (unsynced) Allows modifying the members of group 5
/Group6 (unsynced) Allows modifying the members of group 6
/Group7 (unsynced) Allows modifying the members of group 7
/Group8 (unsynced) Allows modifying the members of group 8
/Group9 (unsynced) Allows modifying the members of group 9
/HardwareCursor (unsynced) Enables/Disables hardware mouse-cursor support
/HideInterface (unsynced) Hide/Show the GUI controlls
/IncGUIOpacity (unsynced) Increases the the opacity(see-through-ness) of GUI elements
/IncreaseViewRadius (unsynced) Increase the view radius (lower performance, nicer view)
/Info (unsynced) Shows/Hides the player roster
/InputTextGeo (unsynced) Move and/or resize the input-text field (the "Say: " thing)
/LastMsgPos (unsynced) Moves the camera to show the position of the last message
/LessClouds (unsynced) Decreases the density of clouds (higher performance)
/LessTrees (unsynced) Decreases distance from the camera at which trees are still drawn
/LODScale (unsynced) Set the scale for either of: LOD (level-of-detail), shadow-LOD, reflection-LOD, refraction-LOD
/LuaGaia (unsynced) Redirects command /LuaGaia to its synced processor
/LuaRules (unsynced) Redirects command /LuaRules to its synced processor
/LuaSave (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/LuaUI (unsynced) Allows one to reload or disable LuaUI, or alternatively to send a chat message to LuaUI
/MapBorder (unsynced) Set or toggle map-border rendering
/MapMarks (unsynced) Enables/Disables map marks rendering
/mapmeshdrawer (unsynced) Switch map-mesh rendering modes: 0=GCM, 1=HLOD, 2=ROAM
/MapShadowPolyOffset (unsynced)
/MaxNanoParticles (unsynced) Set the maximum number of nano-particles (Graphic setting)
/MaxParticles (unsynced) Set the maximum number of particles (Graphics setting)
/MiniMap (unsynced) FIXME document subcommands
/MoreClouds (unsynced) Increases the density of clouds (lower performance)
/MoreTrees (unsynced) Increases distance from the camera at which trees are still drawn
/Mouse1 (unsynced) Simulates a mouse button press of button 1
/Mouse2 (unsynced) Simulates a mouse button press of button 2
/Mouse3 (unsynced) Simulates a mouse button press of button 3
/Mouse4 (unsynced) Simulates a mouse button press of button 4
/Mouse5 (unsynced) Simulates a mouse button press of button 5
/MoveBack (unsynced) Moves the camera Back a bit
/MoveDown (unsynced) Moves the camera Down a bit
/MoveFast (unsynced) Moves the camera Fast a bit
/MoveForward (unsynced) Moves the camera Forward a bit
/MoveLeft (unsynced) Moves the camera Left a bit
/MoveRight (unsynced) Moves the camera Right a bit
/MoveSlow (unsynced) Moves the camera Slow a bit
/MoveUp (unsynced) Moves the camera Up a bit
/MuteSound (unsynced) Mute/Unmute the current sound system
/NoLuaDraw (unsynced) Allow/Disallow Lua to draw on the map
/PasteText (unsynced) Paste either the argument string(s) or if none given, the content of the clip-board to chat input
/Pause (unsynced) Pause/Unpause the game
/QuitForce (unsynced) Exits game to system
/QuitMenu (unsynced) Opens the quit-menu, if it is not already open
/QuitMessage (unsynced) Deprecated, see /Quit instead (was used to quite the game immediately)
/ReloadForce (unsynced) Exits game to menu
/ReloadGame (unsynced) Restarts the game with the initially provided start-script
/ReloadShaders (unsynced) Reloads all engine shaders
/ResBar (unsynced) Shows/Hides team resource storage indicator bar
/Resync (unsynced) Redirects command /Resync to its synced processor
/SafeGL (unsynced) Enables/Disables OpenGL safe-mode
/Save (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/SaveGame (unsynced) Save the game state to QuickSave.ssf (BROKEN)
/Say (unsynced) Say something in (public) chat
/ScreenShot (unsynced) Take a screen-shot of the current view
/Select (unsynced) <chat command description: Select>
/SelectCycle (unsynced) <chat command description: SelectUnits>
/SelectUnits (unsynced) <chat command description: SelectUnits>
/Send (unsynced) Send a string as raw network message to the game host (for debugging only)
/Set (unsynced) Set a config key=value pair
/Shadows (unsynced) Disables/Enables shadows rendering: -1=disabled, 0=off, 1=full shadows, 2=skip terrain shadows
/ShareDialog (unsynced) Opens the share dialog, which allows you to send units and resources to other players
/ShowElevation (unsynced) Enable rendering of the auxiliary height-map overlay
/ShowMetalMap (unsynced) Enable rendering of the auxiliary metal-map overlay
/ShowPathCost (unsynced) Enable rendering of the path cost-map overlay
/ShowPathFlow (unsynced) Enable/Disable rendering of the path flow-map overlay
/ShowPathHeat (unsynced) Enable/Disable rendering of the path heat-map overlay
/ShowPathTraversability (unsynced) Enable rendering of the path traversability-map overlay
/ShowPathType (unsynced) Shows path traversability for a given MoveDefName, MoveDefID or UnitDefName
/ShowStandard (unsynced) Disable rendering of all auxiliary map overlays
/SlowDown (unsynced) Decreases the simulation speed. The engine will try to simulate less frames per second
/SoundChannelEnable (unsynced) Enable/Disable specific sound channels: UnitReply, General, Battle, UserInterface, Music
/SoundDevice (unsynced) Switch the sound output system (currently only OpenAL / NullAudio)
/SpecFullView (unsynced) Sets or toggles between full LOS or ally-team LOS, if the local user is a spectator
/Spectator (unsynced) Lets the local user give up control over a team, and start spectating
/SpecTeam (unsynced) Lets the local user specify the team to follow, if he is a spectator
/Speed (unsynced) Shows/Hides the simulation speed indicator
/SpeedControl (unsynced) Sets how server adjusts speed according to player's load (CPU), 1: use average, 2: use highest,
/SpeedUp (unsynced) Increases the simulation speed. The engine will try to simulate more frames per second
/Take (unsynced) Redirects command /Take to its synced processor
/Team (unsynced) Lets the local user change to another team
/TeamHighlight (unsynced) Enables/Disables uncontrolled team blinking
/ToggleInfo (unsynced) Toggles current info texture view
/ToggleLOS (unsynced) Enable rendering of the auxiliary LOS-map overlay
/ToolTip (unsynced) Enables/Disables the general tool-tips, displayed when hovering over units. features or the map
/Track (unsynced) Start following the selected unit(s) with the camera
/TrackMode (unsynced) Shift through different ways of following selected unit(s)
/TrackOff (unsynced) Stop following the selected unit(s) with the camera
/TSet (unsynced) Set a config key=value pair in the overlay, meaning it will not be persisted for future games
/ViewSelection (unsynced) Moves the camera to the center of the currently selected units
/VSync (unsynced) Enables/Disables vertical-sync (Graphics setting)
/W (unsynced) Say something in private to a specific player, by player-name
/Water (unsynced) Set water rendering mode: 0=basic, 1=reflective, 2=dynamic, 3=reflective&refractive, 4=bump-mapped
/WByNum (unsynced) Say something in private to a specific player, by player-ID
/WireMap (unsynced) Toggle wireframe-mode drawing of map geometry
/WireModel (unsynced) Toggle wireframe-mode drawing of model geometry
/WireSky (unsynced) Toggle wireframe-mode drawing of skydome geometry
/WireTree (unsynced) Toggle wireframe-mode drawing of tree geometry
/WireWater (unsynced) Toggle wireframe-mode drawing of water geometry
</pre>
More commands:
<pre style="overflow:auto; width:auto;">
/bind <keyset> <action> Binds a key or key combination. Example: /bind a reclaim.
/luagaia reload Reloads gaia gadgets
/luarules reload Reloads gadgets
/luaui reload
/luaui tweakgui Tweak mode on
/Setmaxspeed # Changes the maximum speed (default is 3.0)
/Setminspeed # Changes the minimum speed (default is 0.3)
/unbind <keyset> <action> Unbinds a key or key combination. Example: /unbind a reclaim.
/unbindaction <action> Unbinds all keybinds that uses <action>.
/unbindkeyset <keyset> Unbinds all bindings that uses <keyset>.
/unbindall Unbinds all keys except the chat keybinding.
</pre>

=Scripting=
In Lua scripts, these commands can be used like this: 
Spring.SendCommands("resbar 0") 
notice the missing / when used like this. 

[[Category:Help]]

UI commands

2019-10-01T11:10:14Z

Tulipe: /* some commands not showed in output. Placed at the end */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}
=How to use the console=
The ingame chat is the console. Open with hitting the `<code>return</code>` or `<code>enter</code>` key.
If you want to enter a command into ingame chat, you must add a <code>/</code> in front 
for example: <code>/commandhelp</code> 
Some commands will also autocomplete if you press <code>TAB</code>. So if you enter "/com" and then to press TAB, it will complete it to `/command` and tells you there is `/commandhelp` & `/commandlist`, if you now enter either `l` or `h` and press TAB again it will complete to one of them.

Also commands are not case-sensitive.

=List of commands, some are even explained=

For a complete (excluding Lua commands & some engine `actions`) use:
<code>/commandlist</code>

Example output (104.0):
<pre style="overflow:auto; width:auto;">
Chat commands plus description
==============================
/Atm (synced) Gives 1000 metal and 1000 energy to the issuing players team
/Cheat (synced) Enables/Disables cheating, which is required for a lot of other commands to be usable
/Destroy (synced) Destroys one or multiple units by unit-ID, instantly
/DevLua (synced) Enables/Disables Lua dev-mode (can cause desyncs if enabled)
/EditDefs (synced) Allows/Disallows editing of unit-, feature- and weapon-defs through Lua
/Give [amount] <objectName|'all'>(synced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team. Example : /give 10 corkrog 3 - gives team 3 10 corkrogs.
/GlobalLOS (synced) Enables/Disables global line-of-sight, which makes the whole map permanently visible to everyone or to a specific allyteam
/GodMode (synced) Enables/Disables god-mode, which allows all players (even spectators) to control all units (even during replays, which will DESYNC them)
/LuaGaia (synced) Allows reloading or disabling LuaGaia, and to send a chat message to LuaGaia scripts
/LuaRules (synced) Allows reloading or disabling LuaRules, and to send a chat message to LuaRules scripts
/NoCost (synced) Enables/Disables everything-for-free, which allows everyone to build everything for zero resource costs
/NoHelp (synced) Enables/Disables widgets (LuaUI control)
/NoSpecDraw (synced) Allows/Disallows spectators to draw on the map
/NoSpectatorChat (synced) Enables/Disables spectators to use the chat
/ReloadCEGs (synced) Reloads CEG scripts
/ReloadCOB (synced) Reloads COB scripts
/Skip (synced) Fast-forwards to a given frame, or stops fast-forwarding
/Take (synced) Transfers all units of allied teams without any active players to the team of the issuing player
/AdvMapShading (unsynced) Set or toggle advanced map shading mode
/AdvModelShading (unsynced) Set or toggle advanced model shading mode
/AIControl (unsynced) Creates a new instance of a Skirmish AI, to let it controll a specific team
/AIKill (unsynced) Kills the Skirmish AI controlling a specified team
/AIList (unsynced) Prints a list of all currently active Skirmish AIs
/AIReload (unsynced) Reloads the Skirmish AI controlling a specified team
/AirMesh (unsynced) Show/Hide the smooth air-mesh map overlay
/AllMapMarks (unsynced) Show/Hide all map marks drawn so far
/Ally (unsynced) Starts/Ends alliance of the local players ally-team with another ally-team
/ATM (unsynced) Redirects command /ATM to its synced processor
/BufferText (unsynced) Write the argument string(s) directly to the console history, but not anywhere else. This is useful for fast manual issuing of the command, later on
/Chat (unsynced) Starts waiting for intput to be sent to
/ChatAll (unsynced) Starts waiting for intput to be sent to All
/ChatAlly (unsynced) Starts waiting for intput to be sent to Ally
/ChatSpec (unsynced) Starts waiting for intput to be sent to Spec
/ClearMapMarks (unsynced) Remove all map marks drawn so far
/Clock (unsynced) Shows a small digital clock indicating the local time
/CmdColors (unsynced) Reloads cmdcolors.txt
/CommandHelp (unsynced) Prints info about a specific chat command (so far only synced/unsynced and the description)
/CommandList (unsynced) Prints all the available chat commands with description (if available) to the console
/Console (unsynced) Enables/Disables the in-game console
/ControlUnit (unsynced) Start to first-person-control a unit
/Crash (unsynced) Invoke an artificial crash through a NULL-pointer dereference (SIGSEGV)
/CreateVideo (unsynced) Start/Stop capturing a video of the game in progress
/Cross (unsynced) Allows one to exchange and modify the appearance of the cross/mouse-pointer in first-person-control view
/CtrlPanel (unsynced) Reloads GUI config
/Debug (unsynced) Enable/Disable debug rendering mode
/DebugColVol (unsynced) Enable/Disable drawing of collision volumes
/DebugDrawAI (unsynced) Enables/Disables debug drawing for AIs
/DebugGL (unsynced) Enable/Disable OpenGL debug-context output
/DebugGLErrors (unsynced) Enable/Disable OpenGL debug-errors
/DebugInfo (unsynced) Print debug info to the chat/log-file about either: sound, profiling
/DebugPath (unsynced) Enable/Disable drawing of pathfinder debug-data
/DebugTraceRay (unsynced) Enable/Disable drawing of traceray debug-data
/DecGUIOpacity (unsynced) Decreases the the opacity(see-through-ness) of GUI elements
/DecreaseViewRadius (unsynced) Decrease the view radius (higher performance, uglier view)
/Deselect (unsynced) Deselects all currently selected units
/Destroy (unsynced) Destroys one or multiple units by unit-ID, instantly
/DistDraw (unsynced) Set the distance between units and camera, at which they turn into far-textures (flat/texture-only representation) (Graphic setting)
/DistIcon (unsynced) Set the distance between units and camera, at which they turn into icons (Graphic setting)
/DivByZero (unsynced) Invoke an artificial crash by performing a division-by-Zero
/DrawInMap (unsynced) Enables drawing on the map
/DrawLabel (unsynced) Draws a label on the map at the current mouse-pointer position
/DrawTrees (unsynced) Enable/Disable engine-tree rendering
/DumpState (unsynced) dump game-state to file
/DynamicSky (unsynced) Enable/Disable dynamic-sky rendering
/Echo (unsynced) Write a string to the log file
/EndGraph (unsynced) Enables/Disables the statistics graphs shown at the end of the game
/Exception (unsynced) Invoke an artificial crash by throwing an std::runtime_error
/Font (unsynced) Reloads the fonts
/FPS (unsynced) Shows/Hides the frames-per-second indicator
/FPSHud (unsynced) Enables/Disables HUD (GUI interface) shown in first-person-control mode
/Fullscreen (unsynced) Switches fullscreen mode
/GameInfo (unsynced) Enables/Disables game-info panel rendering
/GatherMode (unsynced) Enter/Leave gather-wait command mode
/Give (unsynced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team
/GrabInput (unsynced) Prevents/Enables the mouse from leaving the game window (windowed mode only)
/GroundDecals (unsynced) Disable/Enable ground-decals rendering. Ground-decals are things like scars appearing on the map after an explosion.
/GroundDetail (unsynced) Set the level of ground detail
/Group (unsynced) Allows modifying the members of a group
/Group0 (unsynced) Allows modifying the members of group 0
/Group1 (unsynced) Allows modifying the members of group 1
/Group2 (unsynced) Allows modifying the members of group 2
/Group3 (unsynced) Allows modifying the members of group 3
/Group4 (unsynced) Allows modifying the members of group 4
/Group5 (unsynced) Allows modifying the members of group 5
/Group6 (unsynced) Allows modifying the members of group 6
/Group7 (unsynced) Allows modifying the members of group 7
/Group8 (unsynced) Allows modifying the members of group 8
/Group9 (unsynced) Allows modifying the members of group 9
/HardwareCursor (unsynced) Enables/Disables hardware mouse-cursor support
/HideInterface (unsynced) Hide/Show the GUI controlls
/IncGUIOpacity (unsynced) Increases the the opacity(see-through-ness) of GUI elements
/IncreaseViewRadius (unsynced) Increase the view radius (lower performance, nicer view)
/Info (unsynced) Shows/Hides the player roster
/InputTextGeo (unsynced) Move and/or resize the input-text field (the "Say: " thing)
/LastMsgPos (unsynced) Moves the camera to show the position of the last message
/LessClouds (unsynced) Decreases the density of clouds (higher performance)
/LessTrees (unsynced) Decreases distance from the camera at which trees are still drawn
/LODScale (unsynced) Set the scale for either of: LOD (level-of-detail), shadow-LOD, reflection-LOD, refraction-LOD
/LuaGaia (unsynced) Redirects command /LuaGaia to its synced processor
/LuaRules (unsynced) Redirects command /LuaRules to its synced processor
/LuaSave (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/LuaUI (unsynced) Allows one to reload or disable LuaUI, or alternatively to send a chat message to LuaUI
/MapBorder (unsynced) Set or toggle map-border rendering
/MapMarks (unsynced) Enables/Disables map marks rendering
/mapmeshdrawer (unsynced) Switch map-mesh rendering modes: 0=GCM, 1=HLOD, 2=ROAM
/MapShadowPolyOffset (unsynced)
/MaxNanoParticles (unsynced) Set the maximum number of nano-particles (Graphic setting)
/MaxParticles (unsynced) Set the maximum number of particles (Graphics setting)
/MiniMap (unsynced) FIXME document subcommands
/MoreClouds (unsynced) Increases the density of clouds (lower performance)
/MoreTrees (unsynced) Increases distance from the camera at which trees are still drawn
/Mouse1 (unsynced) Simulates a mouse button press of button 1
/Mouse2 (unsynced) Simulates a mouse button press of button 2
/Mouse3 (unsynced) Simulates a mouse button press of button 3
/Mouse4 (unsynced) Simulates a mouse button press of button 4
/Mouse5 (unsynced) Simulates a mouse button press of button 5
/MoveBack (unsynced) Moves the camera Back a bit
/MoveDown (unsynced) Moves the camera Down a bit
/MoveFast (unsynced) Moves the camera Fast a bit
/MoveForward (unsynced) Moves the camera Forward a bit
/MoveLeft (unsynced) Moves the camera Left a bit
/MoveRight (unsynced) Moves the camera Right a bit
/MoveSlow (unsynced) Moves the camera Slow a bit
/MoveUp (unsynced) Moves the camera Up a bit
/MuteSound (unsynced) Mute/Unmute the current sound system
/NoLuaDraw (unsynced) Allow/Disallow Lua to draw on the map
/PasteText (unsynced) Paste either the argument string(s) or if none given, the content of the clip-board to chat input
/Pause (unsynced) Pause/Unpause the game
/QuitForce (unsynced) Exits game to system
/QuitMenu (unsynced) Opens the quit-menu, if it is not already open
/QuitMessage (unsynced) Deprecated, see /Quit instead (was used to quite the game immediately)
/ReloadForce (unsynced) Exits game to menu
/ReloadGame (unsynced) Restarts the game with the initially provided start-script
/ReloadShaders (unsynced) Reloads all engine shaders
/ResBar (unsynced) Shows/Hides team resource storage indicator bar
/Resync (unsynced) Redirects command /Resync to its synced processor
/SafeGL (unsynced) Enables/Disables OpenGL safe-mode
/Save (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/SaveGame (unsynced) Save the game state to QuickSave.ssf (BROKEN)
/Say (unsynced) Say something in (public) chat
/ScreenShot (unsynced) Take a screen-shot of the current view
/Select (unsynced) <chat command description: Select>
/SelectCycle (unsynced) <chat command description: SelectUnits>
/SelectUnits (unsynced) <chat command description: SelectUnits>
/Send (unsynced) Send a string as raw network message to the game host (for debugging only)
/Set (unsynced) Set a config key=value pair
/Shadows (unsynced) Disables/Enables shadows rendering: -1=disabled, 0=off, 1=full shadows, 2=skip terrain shadows
/ShareDialog (unsynced) Opens the share dialog, which allows you to send units and resources to other players
/ShowElevation (unsynced) Enable rendering of the auxiliary height-map overlay
/ShowMetalMap (unsynced) Enable rendering of the auxiliary metal-map overlay
/ShowPathCost (unsynced) Enable rendering of the path cost-map overlay
/ShowPathFlow (unsynced) Enable/Disable rendering of the path flow-map overlay
/ShowPathHeat (unsynced) Enable/Disable rendering of the path heat-map overlay
/ShowPathTraversability (unsynced) Enable rendering of the path traversability-map overlay
/ShowPathType (unsynced) Shows path traversability for a given MoveDefName, MoveDefID or UnitDefName
/ShowStandard (unsynced) Disable rendering of all auxiliary map overlays
/SlowDown (unsynced) Decreases the simulation speed. The engine will try to simulate less frames per second
/SoundChannelEnable (unsynced) Enable/Disable specific sound channels: UnitReply, General, Battle, UserInterface, Music
/SoundDevice (unsynced) Switch the sound output system (currently only OpenAL / NullAudio)
/SpecFullView (unsynced) Sets or toggles between full LOS or ally-team LOS, if the local user is a spectator
/Spectator (unsynced) Lets the local user give up control over a team, and start spectating
/SpecTeam (unsynced) Lets the local user specify the team to follow, if he is a spectator
/Speed (unsynced) Shows/Hides the simulation speed indicator
/SpeedControl (unsynced) Sets how server adjusts speed according to player's load (CPU), 1: use average, 2: use highest,
/SpeedUp (unsynced) Increases the simulation speed. The engine will try to simulate more frames per second
/Take (unsynced) Redirects command /Take to its synced processor
/Team (unsynced) Lets the local user change to another team
/TeamHighlight (unsynced) Enables/Disables uncontrolled team blinking
/ToggleInfo (unsynced) Toggles current info texture view
/ToggleLOS (unsynced) Enable rendering of the auxiliary LOS-map overlay
/ToolTip (unsynced) Enables/Disables the general tool-tips, displayed when hovering over units. features or the map
/Track (unsynced) Start following the selected unit(s) with the camera
/TrackMode (unsynced) Shift through different ways of following selected unit(s)
/TrackOff (unsynced) Stop following the selected unit(s) with the camera
/TSet (unsynced) Set a config key=value pair in the overlay, meaning it will not be persisted for future games
/ViewSelection (unsynced) Moves the camera to the center of the currently selected units
/VSync (unsynced) Enables/Disables vertical-sync (Graphics setting)
/W (unsynced) Say something in private to a specific player, by player-name
/Water (unsynced) Set water rendering mode: 0=basic, 1=reflective, 2=dynamic, 3=reflective&refractive, 4=bump-mapped
/WByNum (unsynced) Say something in private to a specific player, by player-ID
/WireMap (unsynced) Toggle wireframe-mode drawing of map geometry
/WireModel (unsynced) Toggle wireframe-mode drawing of model geometry
/WireSky (unsynced) Toggle wireframe-mode drawing of skydome geometry
/WireTree (unsynced) Toggle wireframe-mode drawing of tree geometry
/WireWater (unsynced) Toggle wireframe-mode drawing of water geometry
</pre>
More commands:
<pre style="overflow:auto; width:auto;">
/bind <keyset> <action> Binds a key or key combination. Example: /bind a reclaim.
/luagaia reload Reloads gaia gadgets
/luarules reload Reloads gadgets
/luaui reload
/luaui tweakgui Tweak mode on
/Setmaxspeed # Changes the maximum speed (default is 3.0)
/Setminspeed # Changes the minimum speed (default is 0.3)
/unbind <keyset> <action> Unbinds a key or key combination. Example: /unbind a reclaim.
/unbindaction <action> Unbinds all keybinds that uses <action>.
/unbindkeyset <keyset> Unbinds all bindings that uses <keyset>.
/unbindall Unbinds all keys except the chat keybinding.
</pre>

=Scripting=
In Lua scripts, these commands can be used like this: 
Spring.SendCommands("resbar 0") 
notice the missing / when used like this. 

[[Category:Help]]

UI commands

2019-09-29T13:13:22Z

Tulipe: /* Some commands added and give command more detailed */

[[Engine_Development|Development]] < [[Lua_Scripting|Lua Scripting]] < {{FULLPAGENAME}}
=How to use the console=
The ingame chat is the console. Open with hitting the `<code>return</code>` or `<code>enter</code>` key.
If you want to enter a command into ingame chat, you must add a <code>/</code> in front 
for example: <code>/commandhelp</code> 
Some commands will also autocomplete if you press <code>TAB</code>. So if you enter "/com" and then to press TAB, it will complete it to `/command` and tells you there is `/commandhelp` & `/commandlist`, if you now enter either `l` or `h` and press TAB again it will complete to one of them.

Also commands are not case-sensitive.

=List of commands, some are even explained=

For a complete (excluding Lua commands & some engine `actions`) use:
<code>/commandlist</code>

Example output (104.0):
<pre style="overflow:auto; width:auto;">
Chat commands plus description
==============================
/Atm (synced) Gives 1000 metal and 1000 energy to the issuing players team
/Cheat (synced) Enables/Disables cheating, which is required for a lot of other commands to be usable
/Destroy (synced) Destroys one or multiple units by unit-ID, instantly
/DevLua (synced) Enables/Disables Lua dev-mode (can cause desyncs if enabled)
/EditDefs (synced) Allows/Disallows editing of unit-, feature- and weapon-defs through Lua
/Give [amount] <objectName|'all'>(synced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team. Example : /give 10 corkrog 3 - gives team 3 10 corkrogs.
/GlobalLOS (synced) Enables/Disables global line-of-sight, which makes the whole map permanently visible to everyone or to a specific allyteam
/GodMode (synced) Enables/Disables god-mode, which allows all players (even spectators) to control all units (even during replays, which will DESYNC them)
/LuaGaia (synced) Allows reloading or disabling LuaGaia, and to send a chat message to LuaGaia scripts
/luagaia reload Reloads gaia gadgets
/LuaRules (synced) Allows reloading or disabling LuaRules, and to send a chat message to LuaRules scripts
/luarules reload Reloads gadgets
/NoCost (synced) Enables/Disables everything-for-free, which allows everyone to build everything for zero resource costs
/NoHelp (synced) Enables/Disables widgets (LuaUI control)
/NoSpecDraw (synced) Allows/Disallows spectators to draw on the map
/NoSpectatorChat (synced) Enables/Disables spectators to use the chat
/ReloadCEGs (synced) Reloads CEG scripts
/ReloadCOB (synced) Reloads COB scripts
/Skip (synced) Fast-forwards to a given frame, or stops fast-forwarding
/Take (synced) Transfers all units of allied teams without any active players to the team of the issuing player
/AdvMapShading (unsynced) Set or toggle advanced map shading mode
/AdvModelShading (unsynced) Set or toggle advanced model shading mode
/AIControl (unsynced) Creates a new instance of a Skirmish AI, to let it controll a specific team
/AIKill (unsynced) Kills the Skirmish AI controlling a specified team
/AIList (unsynced) Prints a list of all currently active Skirmish AIs
/AIReload (unsynced) Reloads the Skirmish AI controlling a specified team
/AirMesh (unsynced) Show/Hide the smooth air-mesh map overlay
/AllMapMarks (unsynced) Show/Hide all map marks drawn so far
/Ally (unsynced) Starts/Ends alliance of the local players ally-team with another ally-team
/ATM (unsynced) Redirects command /ATM to its synced processor
/bind <keyset> <action> Binds a key or key combination. Example: /bind a reclaim.
/BufferText (unsynced) Write the argument string(s) directly to the console history, but not anywhere else. This is useful for fast manual issuing of the command, later on
/Chat (unsynced) Starts waiting for intput to be sent to
/ChatAll (unsynced) Starts waiting for intput to be sent to All
/ChatAlly (unsynced) Starts waiting for intput to be sent to Ally
/ChatSpec (unsynced) Starts waiting for intput to be sent to Spec
/ClearMapMarks (unsynced) Remove all map marks drawn so far
/Clock (unsynced) Shows a small digital clock indicating the local time
/CmdColors (unsynced) Reloads cmdcolors.txt
/CommandHelp (unsynced) Prints info about a specific chat command (so far only synced/unsynced and the description)
/CommandList (unsynced) Prints all the available chat commands with description (if available) to the console
/Console (unsynced) Enables/Disables the in-game console
/ControlUnit (unsynced) Start to first-person-control a unit
/Crash (unsynced) Invoke an artificial crash through a NULL-pointer dereference (SIGSEGV)
/CreateVideo (unsynced) Start/Stop capturing a video of the game in progress
/Cross (unsynced) Allows one to exchange and modify the appearance of the cross/mouse-pointer in first-person-control view
/CtrlPanel (unsynced) Reloads GUI config
/Debug (unsynced) Enable/Disable debug rendering mode
/DebugColVol (unsynced) Enable/Disable drawing of collision volumes
/DebugDrawAI (unsynced) Enables/Disables debug drawing for AIs
/DebugGL (unsynced) Enable/Disable OpenGL debug-context output
/DebugGLErrors (unsynced) Enable/Disable OpenGL debug-errors
/DebugInfo (unsynced) Print debug info to the chat/log-file about either: sound, profiling
/DebugPath (unsynced) Enable/Disable drawing of pathfinder debug-data
/DebugTraceRay (unsynced) Enable/Disable drawing of traceray debug-data
/DecGUIOpacity (unsynced) Decreases the the opacity(see-through-ness) of GUI elements
/DecreaseViewRadius (unsynced) Decrease the view radius (higher performance, uglier view)
/Deselect (unsynced) Deselects all currently selected units
/Destroy (unsynced) Destroys one or multiple units by unit-ID, instantly
/DistDraw (unsynced) Set the distance between units and camera, at which they turn into far-textures (flat/texture-only representation) (Graphic setting)
/DistIcon (unsynced) Set the distance between units and camera, at which they turn into icons (Graphic setting)
/DivByZero (unsynced) Invoke an artificial crash by performing a division-by-Zero
/DrawInMap (unsynced) Enables drawing on the map
/DrawLabel (unsynced) Draws a label on the map at the current mouse-pointer position
/DrawTrees (unsynced) Enable/Disable engine-tree rendering
/DumpState (unsynced) dump game-state to file
/DynamicSky (unsynced) Enable/Disable dynamic-sky rendering
/Echo (unsynced) Write a string to the log file
/EndGraph (unsynced) Enables/Disables the statistics graphs shown at the end of the game
/Exception (unsynced) Invoke an artificial crash by throwing an std::runtime_error
/Font (unsynced) Reloads the fonts
/FPS (unsynced) Shows/Hides the frames-per-second indicator
/FPSHud (unsynced) Enables/Disables HUD (GUI interface) shown in first-person-control mode
/Fullscreen (unsynced) Switches fullscreen mode
/GameInfo (unsynced) Enables/Disables game-info panel rendering
/GatherMode (unsynced) Enter/Leave gather-wait command mode
/Give (unsynced) Places one or multiple units of a single or multiple types on the map, instantly; by default to your own team
/GrabInput (unsynced) Prevents/Enables the mouse from leaving the game window (windowed mode only)
/GroundDecals (unsynced) Disable/Enable ground-decals rendering. Ground-decals are things like scars appearing on the map after an explosion.
/GroundDetail (unsynced) Set the level of ground detail
/Group (unsynced) Allows modifying the members of a group
/Group0 (unsynced) Allows modifying the members of group 0
/Group1 (unsynced) Allows modifying the members of group 1
/Group2 (unsynced) Allows modifying the members of group 2
/Group3 (unsynced) Allows modifying the members of group 3
/Group4 (unsynced) Allows modifying the members of group 4
/Group5 (unsynced) Allows modifying the members of group 5
/Group6 (unsynced) Allows modifying the members of group 6
/Group7 (unsynced) Allows modifying the members of group 7
/Group8 (unsynced) Allows modifying the members of group 8
/Group9 (unsynced) Allows modifying the members of group 9
/HardwareCursor (unsynced) Enables/Disables hardware mouse-cursor support
/HideInterface (unsynced) Hide/Show the GUI controlls
/IncGUIOpacity (unsynced) Increases the the opacity(see-through-ness) of GUI elements
/IncreaseViewRadius (unsynced) Increase the view radius (lower performance, nicer view)
/Info (unsynced) Shows/Hides the player roster
/InputTextGeo (unsynced) Move and/or resize the input-text field (the "Say: " thing)
/LastMsgPos (unsynced) Moves the camera to show the position of the last message
/LessClouds (unsynced) Decreases the density of clouds (higher performance)
/LessTrees (unsynced) Decreases distance from the camera at which trees are still drawn
/LODScale (unsynced) Set the scale for either of: LOD (level-of-detail), shadow-LOD, reflection-LOD, refraction-LOD
/LuaGaia (unsynced) Redirects command /LuaGaia to its synced processor
/LuaRules (unsynced) Redirects command /LuaRules to its synced processor
/LuaSave (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/LuaUI (unsynced) Allows one to reload or disable LuaUI, or alternatively to send a chat message to LuaUI
/luaui tweakgui Tweak mode on
/MapBorder (unsynced) Set or toggle map-border rendering
/MapMarks (unsynced) Enables/Disables map marks rendering
/mapmeshdrawer (unsynced) Switch map-mesh rendering modes: 0=GCM, 1=HLOD, 2=ROAM
/MapShadowPolyOffset (unsynced)
/MaxNanoParticles (unsynced) Set the maximum number of nano-particles (Graphic setting)
/MaxParticles (unsynced) Set the maximum number of particles (Graphics setting)
/MiniMap (unsynced) FIXME document subcommands
/MoreClouds (unsynced) Increases the density of clouds (lower performance)
/MoreTrees (unsynced) Increases distance from the camera at which trees are still drawn
/Mouse1 (unsynced) Simulates a mouse button press of button 1
/Mouse2 (unsynced) Simulates a mouse button press of button 2
/Mouse3 (unsynced) Simulates a mouse button press of button 3
/Mouse4 (unsynced) Simulates a mouse button press of button 4
/Mouse5 (unsynced) Simulates a mouse button press of button 5
/MoveBack (unsynced) Moves the camera Back a bit
/MoveDown (unsynced) Moves the camera Down a bit
/MoveFast (unsynced) Moves the camera Fast a bit
/MoveForward (unsynced) Moves the camera Forward a bit
/MoveLeft (unsynced) Moves the camera Left a bit
/MoveRight (unsynced) Moves the camera Right a bit
/MoveSlow (unsynced) Moves the camera Slow a bit
/MoveUp (unsynced) Moves the camera Up a bit
/MuteSound (unsynced) Mute/Unmute the current sound system
/NoLuaDraw (unsynced) Allow/Disallow Lua to draw on the map
/PasteText (unsynced) Paste either the argument string(s) or if none given, the content of the clip-board to chat input
/Pause (unsynced) Pause/Unpause the game
/QuitForce (unsynced) Exits game to system
/QuitMenu (unsynced) Opens the quit-menu, if it is not already open
/QuitMessage (unsynced) Deprecated, see /Quit instead (was used to quite the game immediately)
/ReloadForce (unsynced) Exits game to menu
/ReloadGame (unsynced) Restarts the game with the initially provided start-script
/ReloadShaders (unsynced) Reloads all engine shaders
/ResBar (unsynced) Shows/Hides team resource storage indicator bar
/Resync (unsynced) Redirects command /Resync to its synced processor
/SafeGL (unsynced) Enables/Disables OpenGL safe-mode
/Save (unsynced) Save the game state to a specific file, add -y to overwrite when file is already present
/SaveGame (unsynced) Save the game state to QuickSave.ssf (BROKEN)
/Say (unsynced) Say something in (public) chat
/ScreenShot (unsynced) Take a screen-shot of the current view
/Select (unsynced) <chat command description: Select>
/SelectCycle (unsynced) <chat command description: SelectUnits>
/SelectUnits (unsynced) <chat command description: SelectUnits>
/Send (unsynced) Send a string as raw network message to the game host (for debugging only)
/Set (unsynced) Set a config key=value pair
/Setmaxspeed # Changes the maximum speed multiplier (default is 3.0)
/Setminspeed # Changes the minimum speed multiplier (default is 0.3)
/Shadows (unsynced) Disables/Enables shadows rendering: -1=disabled, 0=off, 1=full shadows, 2=skip terrain shadows
/ShareDialog (unsynced) Opens the share dialog, which allows you to send units and resources to other players
/ShowElevation (unsynced) Enable rendering of the auxiliary height-map overlay
/ShowMetalMap (unsynced) Enable rendering of the auxiliary metal-map overlay
/ShowPathCost (unsynced) Enable rendering of the path cost-map overlay
/ShowPathFlow (unsynced) Enable/Disable rendering of the path flow-map overlay
/ShowPathHeat (unsynced) Enable/Disable rendering of the path heat-map overlay
/ShowPathTraversability (unsynced) Enable rendering of the path traversability-map overlay
/ShowPathType (unsynced) Shows path traversability for a given MoveDefName, MoveDefID or UnitDefName
/ShowStandard (unsynced) Disable rendering of all auxiliary map overlays
/SlowDown (unsynced) Decreases the simulation speed. The engine will try to simulate less frames per second
/SoundChannelEnable (unsynced) Enable/Disable specific sound channels: UnitReply, General, Battle, UserInterface, Music
/SoundDevice (unsynced) Switch the sound output system (currently only OpenAL / NullAudio)
/SpecFullView (unsynced) Sets or toggles between full LOS or ally-team LOS, if the local user is a spectator
/Spectator (unsynced) Lets the local user give up control over a team, and start spectating
/SpecTeam (unsynced) Lets the local user specify the team to follow, if he is a spectator
/Speed (unsynced) Shows/Hides the simulation speed indicator
/SpeedControl (unsynced) Sets how server adjusts speed according to player's load (CPU), 1: use average, 2: use highest,
/SpeedUp (unsynced) Increases the simulation speed. The engine will try to simulate more frames per second
/Take (unsynced) Redirects command /Take to its synced processor
/Team (unsynced) Lets the local user change to another team
/TeamHighlight (unsynced) Enables/Disables uncontrolled team blinking
/ToggleInfo (unsynced) Toggles current info texture view
/ToggleLOS (unsynced) Enable rendering of the auxiliary LOS-map overlay
/ToolTip (unsynced) Enables/Disables the general tool-tips, displayed when hovering over units. features or the map
/Track (unsynced) Start following the selected unit(s) with the camera
/TrackMode (unsynced) Shift through different ways of following selected unit(s)
/TrackOff (unsynced) Stop following the selected unit(s) with the camera
/TSet (unsynced) Set a config key=value pair in the overlay, meaning it will not be persisted for future games
/unbind <keyset> <action> Unbinds a key or key combination. Example: /unbind a reclaim.
/ViewSelection (unsynced) Moves the camera to the center of the currently selected units
/VSync (unsynced) Enables/Disables vertical-sync (Graphics setting)
/W (unsynced) Say something in private to a specific player, by player-name
/Water (unsynced) Set water rendering mode: 0=basic, 1=reflective, 2=dynamic, 3=reflective&refractive, 4=bump-mapped
/WByNum (unsynced) Say something in private to a specific player, by player-ID
/WireMap (unsynced) Toggle wireframe-mode drawing of map geometry
/WireModel (unsynced) Toggle wireframe-mode drawing of model geometry
/WireSky (unsynced) Toggle wireframe-mode drawing of skydome geometry
/WireTree (unsynced) Toggle wireframe-mode drawing of tree geometry
/WireWater (unsynced) Toggle wireframe-mode drawing of water geometry
</pre>

=Scripting=
In Lua scripts, these commands can be used like this: 
Spring.SendCommands("resbar 0") 
notice the missing / when used like this. 

[[Category:Help]]

Uikeys.txt

2018-07-14T05:50:35Z

Tulipe: /* selections */

= uikeys.txt =

==Location==
The file has to be placed into the SpringData dir, most common next to [[springsettings.cfg]].

==example==

{{sourcelink|file=doc/uikeys.txt}}

==get key codes==
to see what keycodes are triggered when a key is pressed, enable keydebug mode with

<code><pre>
/keydebug
</pre></code>

== 97.0 ==
In 97.0 support was added for '''KeyChains''' for example:
<code>/bind Ctrl+a,Ctrl+b say Hello World!</code>

You can double bind a button this way, e.g.:
<code>/bind e,e say Bar
/bind e say Foo</code>
Results in the 1st press printing Foo, 2nd press printing Bar.

Additionally '''KeyChains''' are now used for several defaults:
* Double hitting drawbutton sets label
* Switching between ally, spec & all chat is now done by double hitting <code>alt</code>, <code>shift</code> or <code>ctrl</code>
* <code>alt+return</code> now toggles fullscreen (default shortcut for fullscreen toggle on most OS)

== 104.0 ==
In 104.0 the default bindings for chat switching changed again;
* <code>alt+ctrl+(a,a)</code> now toggles chatswitchally
* <code>alt+ctrl+(s,s)</code> now toggles chatswitchspec
* <code>chatswitchall</code> now has to be bound manually

==selections==
For details consult the source: SelectionKeyHandler.cpp.

In the following, "+" and "_" are taken as literal plus and underscore characters, respectively. "|" means "or", and "[...]" means that ... is optional.

uikeys.txt has the format
KEY SOURCE+FILTER+CONCLUSION+
"SOURCE+FILTER+CONCLUSION+" will be called the ''selector''.
Generally, all elements of the selector are separated by _, where the + does not count as a separator on its own. You'll see what I mean.

Note that:
* SOURCE, FILTER and CONCLUSION are case sensitive, at least sometimes
* Spaces are significant. Do not insert any spaces in the selector string!
* Do not use a KEY that has already been bound to something else (this holds for SelectionEditor too).

The format for KEY is different from uikeys.txt: Use a combination of <code>Shift</code> <code>Control</code> <code>Alt</code> followed by a key A-Z or 0-9, all separated by an underscore _.
Example:
Control_W
Alt_Shift_0

SOURCE describes the set of units that you want to filter and pick a selection from.
It can be one of
* <code>AllMap</code>: obvious
* <code>Visible</code>: obvious
* <code>FromMouse_D</code>, where D is some number: all units that are at most a distance of D away from the mouse cursor
* <code>PrevSelection</code>: the previous selection; that is, the one active before you hit the selection key

FILTER is an arbitrarily long list of filters.
Every filter can be preceded by <code>Not</code> to negate it.
You will still have to use a _ to separate the <code>Not</code> from the filter, as in <code>Not_Commander</code>.

Here are the filters. Note that "units" generally means both buildings and units. Typing both got old real quick.
* <code>AbsoluteHealth_N</code>: only units that have an absolute health > N
* <code>Aircraft</code>
* <code>Builder</code>: only construction units
* <code>Building</code>: only buildings
* <code>Category_C</code>: only units of category C -- XXX what are the categories?
* <code>Commander</code>: do not works since at least version 104
* <code>Idle</code>
* <code>InHotkeyGroup</code>: only units that are in a group
* <code>InPrevSel</code>: only units of the same type as a unit in the previous selection
* <code>NameContain_S</code>: only units whose name contains the string S
* <code>Radar</code>: only units with either radar, sonar, or a jammer
* <code>RelativeHealth_P</code>: only units that have health > P percent
* <code>Transport</code>
* <code>Waiting</code>: only units that are under a wait command (usually W)
* <code>WeaponRange_D</code>: only units that have a weapon range > D
* <code>Weapons</code>: only units that have weapons

CONCLUSION is
[_ClearSelection]_HOWMANY
If you specify <code>ClearSelection</code>, your new selection will replace the old one; otherwise, it will just add to it.
HOWMANY must be exactly one of
* <code>SelectAll</code>: all units
* <code>SelectOne</code>: one unit, will also center the camera on that unit
* <code>SelectNum_N</code>: at most N units -- XXX I think this includes the previously selected units (without ClearSelection), check!
* <code>SelectPart_P</code>: P percent of the units

Recall that between every two tokens, there ''must'' be an underscore _, even if there is also a +. Another way to put it is that before every word in your selector except the SOURCE, there must be an underscore.

Some examples, first the standard bindings. Again, "unit" also includes buildings.
Control_A AllMap++_ClearSelection_SelectAll+
Selects everything on the entire map.
Control_B AllMap+_Builder_Idle+_ClearSelection_SelectOne+
Selects any (one) idle builder on entire map.
Control_C AllMap+_Commander+_ClearSelection_SelectOne+
Selects your commander.
Control_R AllMap+_Radar+_ClearSelection_SelectAll+
Selects all units with radar/sonar/jammer.
Control_W AllMap+_Not_Aircraft_Weapons+_ClearSelection_SelectAll+
Selects all non-aircraft armed units
Control_Z AllMap+_InPrevSel+_ClearSelection_SelectAll+
Selects all units of a type that was in your previous selection.

Note that up to now, all keys said <code>ClearSelection</code>, hence they replaced your old selection.
Control_X AllMap+_InPrevSel_Not_InHotkeyGroup+_SelectAll+
Selects all units of a type that was in your previous selection, unless they are already in a hotkey group. (Use case: if you have a set of tanks on group 1, and have since produced more of the same type(s), you could hit 1 Ctrl+V Ctrl+1 to include them in the group.)
Control_V AllMap+_Not_Builder_Not_Commander_InPrevSel_Not_InHotkeyGroup+_SelectAll+
Selects all units of a type that was in your previous selection, except builders and commander, unless they are already in a hotkey group.

And finally, an example from the forums:
Control_W PrevSelection+_Not_Building_Not_RelativeHealth_30+_ClearSelection_SelectAll+
From your previous selection, leaves everything that is below 30% health, and not a building. (Use this to quickly retreat damaged units.)

==make uikeys.txt read only for SpringSettings==

If you wish to aviod [[SpringSettings]] parsing and possibly ovewriting your uikeys.txt, add this line to uikeys.txt:
<code><pre>//SPRINGSETTINGS DO NOT TOUCH</pre></code>

[[Category:Help]]

Uikeys.txt

2018-07-14T05:48:40Z

Tulipe: /* selections */

= uikeys.txt =

==Location==
The file has to be placed into the SpringData dir, most common next to [[springsettings.cfg]].

==example==

{{sourcelink|file=doc/uikeys.txt}}

==get key codes==
to see what keycodes are triggered when a key is pressed, enable keydebug mode with

<code><pre>
/keydebug
</pre></code>

== 97.0 ==
In 97.0 support was added for '''KeyChains''' for example:
<code>/bind Ctrl+a,Ctrl+b say Hello World!</code>

You can double bind a button this way, e.g.:
<code>/bind e,e say Bar
/bind e say Foo</code>
Results in the 1st press printing Foo, 2nd press printing Bar.

Additionally '''KeyChains''' are now used for several defaults:
* Double hitting drawbutton sets label
* Switching between ally, spec & all chat is now done by double hitting <code>alt</code>, <code>shift</code> or <code>ctrl</code>
* <code>alt+return</code> now toggles fullscreen (default shortcut for fullscreen toggle on most OS)

== 104.0 ==
In 104.0 the default bindings for chat switching changed again;
* <code>alt+ctrl+(a,a)</code> now toggles chatswitchally
* <code>alt+ctrl+(s,s)</code> now toggles chatswitchspec
* <code>chatswitchall</code> now has to be bound manually

==selections==
For details consult the source: SelectionKeyHandler.cpp.

In the following, "+" and "_" are taken as literal plus and underscore characters, respectively. "|" means "or", and "[...]" means that ... is optional.

uikeys.txt has the format
KEY SOURCE+FILTER+CONCLUSION+
"SOURCE+FILTER+CONCLUSION+" will be called the ''selector''.
Generally, all elements of the selector are separated by _, where the + does not count as a separator on its own. You'll see what I mean.

Note that
* SOURCE is case sensitive, at least sometimes
* Spaces are significant. Do not insert any spaces in the selector string!
* Do not use a KEY that has already been bound to something else (this holds for SelectionEditor too).

The format for KEY is different from uikeys.txt: Use a combination of <code>Shift</code> <code>Control</code> <code>Alt</code> followed by a key A-Z or 0-9, all separated by an underscore _.
Example:
Control_W
Alt_Shift_0

SOURCE describes the set of units that you want to filter and pick a selection from.
It can be one of
* <code>AllMap</code>: obvious
* <code>Visible</code>: obvious
* <code>FromMouse_D</code>, where D is some number: all units that are at most a distance of D away from the mouse cursor
* <code>PrevSelection</code>: the previous selection; that is, the one active before you hit the selection key

FILTER is an arbitrarily long list of filters.
Every filter can be preceded by <code>Not</code> to negate it.
You will still have to use a _ to separate the <code>Not</code> from the filter, as in <code>Not_Commander</code>.

Here are the filters. Note that "units" generally means both buildings and units. Typing both got old real quick.
* <code>AbsoluteHealth_N</code>: only units that have an absolute health > N
* <code>Aircraft</code>
* <code>Builder</code>: only construction units
* <code>Building</code>: only buildings
* <code>Category_C</code>: only units of category C -- XXX what are the categories?
* <code>Commander</code>: do not works since at least version 104
* <code>Idle</code>
* <code>InHotkeyGroup</code>: only units that are in a group
* <code>InPrevSel</code>: only units of the same type as a unit in the previous selection
* <code>NameContain_S</code>: only units whose name contains the string S
* <code>Radar</code>: only units with either radar, sonar, or a jammer
* <code>RelativeHealth_P</code>: only units that have health > P percent
* <code>Transport</code>
* <code>Waiting</code>: only units that are under a wait command (usually W)
* <code>WeaponRange_D</code>: only units that have a weapon range > D
* <code>Weapons</code>: only units that have weapons

CONCLUSION is
[_ClearSelection]_HOWMANY
If you specify <code>ClearSelection</code>, your new selection will replace the old one; otherwise, it will just add to it.
HOWMANY must be exactly one of
* <code>SelectAll</code>: all units
* <code>SelectOne</code>: one unit, will also center the camera on that unit
* <code>SelectNum_N</code>: at most N units -- XXX I think this includes the previously selected units (without ClearSelection), check!
* <code>SelectPart_P</code>: P percent of the units

Recall that between every two tokens, there ''must'' be an underscore _, even if there is also a +. Another way to put it is that before every word in your selector except the SOURCE, there must be an underscore.

Some examples, first the standard bindings. Again, "unit" also includes buildings.
Control_A AllMap++_ClearSelection_SelectAll+
Selects everything on the entire map.
Control_B AllMap+_Builder_Idle+_ClearSelection_SelectOne+
Selects any (one) idle builder on entire map.
Control_C AllMap+_Commander+_ClearSelection_SelectOne+
Selects your commander.
Control_R AllMap+_Radar+_ClearSelection_SelectAll+
Selects all units with radar/sonar/jammer.
Control_W AllMap+_Not_Aircraft_Weapons+_ClearSelection_SelectAll+
Selects all non-aircraft armed units
Control_Z AllMap+_InPrevSel+_ClearSelection_SelectAll+
Selects all units of a type that was in your previous selection.

Note that up to now, all keys said <code>ClearSelection</code>, hence they replaced your old selection.
Control_X AllMap+_InPrevSel_Not_InHotkeyGroup+_SelectAll+
Selects all units of a type that was in your previous selection, unless they are already in a hotkey group. (Use case: if you have a set of tanks on group 1, and have since produced more of the same type(s), you could hit 1 Ctrl+V Ctrl+1 to include them in the group.)
Control_V AllMap+_Not_Builder_Not_Commander_InPrevSel_Not_InHotkeyGroup+_SelectAll+
Selects all units of a type that was in your previous selection, except builders and commander, unless they are already in a hotkey group.

And finally, an example from the forums:
Control_W PrevSelection+_Not_Building_Not_RelativeHealth_30+_ClearSelection_SelectAll+
From your previous selection, leaves everything that is below 30% health, and not a building. (Use this to quickly retreat damaged units.)

==make uikeys.txt read only for SpringSettings==

If you wish to aviod [[SpringSettings]] parsing and possibly ovewriting your uikeys.txt, add this line to uikeys.txt:
<code><pre>//SPRINGSETTINGS DO NOT TOUCH</pre></code>

[[Category:Help]]

Uikeys.txt

2018-06-02T18:00:48Z

Tulipe:

= uikeys.txt =

==Location==
The file has to be placed into the SpringData dir, most common next to [[springsettings.cfg]].

==example==

{{sourcelink|file=doc/uikeys.txt}}

==get key codes==
to see what keycodes are triggered when a key is pressed, enable keydebug mode with

<code><pre>
/keydebug
</pre></code>

== 97.0 ==
In 97.0 support was added for '''KeyChains''' for example:
<code>/bind Ctrl+a,Ctrl+b say Hello World!</code>

You can double bind a button this way, e.g.:
<code>/bind e,e say Bar
/bind e say Foo</code>
Results in the 1st press printing Foo, 2nd press printing Bar.

Additionally '''KeyChains''' are now used for several defaults:
* Double hitting drawbutton sets label
* Switching between ally, spec & all chat is now done by double hitting <code>alt</code>, <code>shift</code> or <code>ctrl</code>
* <code>alt+return</code> now toggles fullscreen (default shortcut for fullscreen toggle on most OS)

== 104.0 ==
In 104.0 the default bindings for chat switching changed again;
* <code>alt+ctrl+(a,a)</code> now toggles chatswitchally
* <code>alt+ctrl+(s,s)</code> now toggles chatswitchspec
* <code>chatswitchall</code> now has to be bound manually

==selections==
For details consult the source: SelectionKeyHandler.cpp.

In the following, "+" and "_" are taken as literal plus and underscore characters, respectively. "|" means "or", and "[...]" means that ... is optional.

uikeys.txt has the format
KEY SOURCE+FILTER+CONCLUSION+
"SOURCE+FILTER+CONCLUSION+" will be called the ''selector''.
Generally, all elements of the selector are separated by _, where the + does not count as a separator on its own. You'll see what I mean.

Note that
* Spaces are significant. Do not insert any spaces in the selector string!
* Do not use a KEY that has already been bound to something else (this holds for SelectionEditor too).

The format for KEY is different from uikeys.txt: Use a combination of <code>Shift</code> <code>Control</code> <code>Alt</code> followed by a key A-Z or 0-9, all separated by an underscore _.
Example:
Control_W
Alt_Shift_0

SOURCE describes the set of units that you want to filter and pick a selection from.
It can be one of
* <code>AllMap</code>: obvious
* <code>Visible</code>: obvious
* <code>FromMouse_D</code>, where D is some number: all units that are at most a distance of D away from the mouse cursor
* <code>PrevSelection</code>: the previous selection; that is, the one active before you hit the selection key

FILTER is an arbitrarily long list of filters.
Every filter can be preceded by <code>Not</code> to negate it.
You will still have to use a _ to separate the <code>Not</code> from the filter, as in <code>Not_Commander</code>.

Here are the filters. Note that "units" generally means both buildings and units. Typing both got old real quick.
* <code>AbsoluteHealth_N</code>: only units that have an absolute health > N
* <code>Aircraft</code>
* <code>Builder</code>: only construction units
* <code>Building</code>: only buildings
* <code>Category_C</code>: only units of category C -- XXX what are the categories?
* <code>Commander</code>: do not works since at least version 104
* <code>Idle</code>
* <code>InHotkeyGroup</code>: only units that are in a group
* <code>InPrevSel</code>: only units of the same type as a unit in the previous selection
* <code>NameContain_S</code>: only units whose name contains the string S
* <code>Radar</code>: only units with either radar, sonar, or a jammer
* <code>RelativeHealth_P</code>: only units that have health > P percent
* <code>Transport</code>
* <code>Waiting</code>: only units that are under a wait command (usually W)
* <code>WeaponRange_D</code>: only units that have a weapon range > D
* <code>Weapons</code>: only units that have weapons

CONCLUSION is
[_ClearSelection]_HOWMANY
If you specify <code>ClearSelection</code>, your new selection will replace the old one; otherwise, it will just add to it.
HOWMANY must be exactly one of
* <code>SelectAll</code>: all units
* <code>SelectOne</code>: one unit, will also center the camera on that unit
* <code>SelectNum_N</code>: at most N units -- XXX I think this includes the previously selected units (without ClearSelection), check!
* <code>SelectPart_P</code>: P percent of the units

Recall that between every two tokens, there ''must'' be an underscore _, even if there is also a +. Another way to put it is that before every word in your selector except the SOURCE, there must be an underscore.

Some examples, first the standard bindings. Again, "unit" also includes buildings.
Control_A AllMap++_ClearSelection_SelectAll+
Selects everything on the entire map.
Control_B AllMap+_Builder_Idle+_ClearSelection_SelectOne+
Selects any (one) idle builder on entire map.
Control_C AllMap+_Commander+_ClearSelection_SelectOne+
Selects your commander.
Control_R AllMap+_Radar+_ClearSelection_SelectAll+
Selects all units with radar/sonar/jammer.
Control_W AllMap+_Not_Aircraft_Weapons+_ClearSelection_SelectAll+
Selects all non-aircraft armed units
Control_Z AllMap+_InPrevSel+_ClearSelection_SelectAll+
Selects all units of a type that was in your previous selection.

Note that up to now, all keys said <code>ClearSelection</code>, hence they replaced your old selection.
Control_X AllMap+_InPrevSel_Not_InHotkeyGroup+_SelectAll+
Selects all units of a type that was in your previous selection, unless they are already in a hotkey group. (Use case: if you have a set of tanks on group 1, and have since produced more of the same type(s), you could hit 1 Ctrl+V Ctrl+1 to include them in the group.)
Control_V AllMap+_Not_Builder_Not_Commander_InPrevSel_Not_InHotkeyGroup+_SelectAll+
Selects all units of a type that was in your previous selection, except builders and commander, unless they are already in a hotkey group.

And finally, an example from the forums:
Control_W PrevSelection+_Not_Building_Not_RelativeHealth_30+_ClearSelection_SelectAll+
From your previous selection, leaves everything that is below 30% health, and not a building. (Use this to quickly retreat damaged units.)

==make uikeys.txt read only for SpringSettings==

If you wish to aviod [[SpringSettings]] parsing and possibly ovewriting your uikeys.txt, add this line to uikeys.txt:
<code><pre>//SPRINGSETTINGS DO NOT TOUCH</pre></code>

[[Category:Help]]