Difference between revisions of "CommandMode"

Revision as of 18:52, 28 April 2006

Command Mode

You can access command mode by typing ' : ' in a single player or multiplayer scenario. (Prior to version 1.1.1, you need to type shift - semicolon( ; ). However this isn't possible on all keyboards; if your keyboard doesn't have ':' above ';' you can change the hotkey in the Preferences, or you could edit game.cfg by hand.')

Several vi-like commands are available in command mode. They are defined in playturn.cpp in the turn_info::do_command() function:

:q or :q!: quit the scenario (without prompting)
:w: save the game (without prompting)
:wq: save the game and quit the scenario (without prompting)
:refresh: redraw the screen
:droid side: toggle player on side between human and AI players. If a human controls the side, the player himself has to issue this command.
:kick username: kick a user in multiplayer. They will be able to rejoin the game. Generally a friendly way to remove someone who is having connection or other difficulties.
:ban username: kick and ban a user in multiplayer, and the IP address used by that username
:control side username: change the controller for side (write here number of the side) to username (write here nick of player or observer)
:clear: clear chat messages
:debug: switch debug mode on (does not work in multiplayer). Debug mode is turned off by quitting the game.
:theme: bring up theme selection menu

Extra Debugging Commands

DebugMode enables additional commands in command mode:

:n: skip to next scenario by triggering a win event
:gold amount: add amount gold to the current player's side
:create unit_type: create a unit of type specified at last selected hex
:unit attribute=value: when a unit is selected, this will set the unit's attribute to value. See SingleUnitWML for possible values.

@@ Line 1: / Line 1: @@
+== Command Mode ==
+You can access command mode by typing ' ''':''' ' in a single player or multiplayer scenario.
+(Prior to version 1.1.1, you need to type shift - semicolon( ''';''' ). However this isn't possible on all keyboards; if your keyboard doesn't have ':' above ';' you can change the hotkey in the Preferences, or you could edit '''game.cfg''' by hand.')
+Several vi-like commands are available in command mode. They are defined in ''playturn.cpp'' in the ''turn_info::do_command()'' function:
+;<nowiki>:q or :q!</nowiki>
+:quit the scenario (without prompting)
+;<nowiki>:w</nowiki>
+:save the game (without prompting)
+;<nowiki>:wq</nowiki>
+:save the game and quit the scenario (without prompting)
+;<nowiki>:refresh</nowiki>
+:redraw the screen
+;<nowiki>:droid</nowiki> ''side''
+:toggle player on side between human and AI players. If a human controls the side, the player himself has to issue this command.
+;<nowiki>:kick</nowiki> ''username''
+:kick a user in multiplayer. They will be able to rejoin the game. Generally a friendly way to remove someone who is having connection or other difficulties.
+;<nowiki>:ban</nowiki> ''username''
+:kick and ban a user in multiplayer, and the IP address used by that username
+;<nowiki>:control</nowiki> ''side'' ''username''
+:change the controller for ''side'' (write here number of the side) to ''username'' (write here nick of player or observer)
+;<nowiki>:clear</nowiki>
+:clear chat messages
+;<nowiki>:debug</nowiki>
+:switch debug mode on (does not work in multiplayer).  Debug mode is turned off by quitting the game.
+;<nowiki>:theme</nowiki>
+:bring up theme selection menu
+===Extra Debugging Commands===
+[[DebugMode]] enables additional commands in command mode:
+;<nowiki>:n</nowiki>
+:skip to next scenario by triggering a win event
+;<nowiki>:gold</nowiki> ''amount''
+:add ''amount'' gold to the current player's side
+;<nowiki>:create</nowiki> ''unit_type''
+:create a unit of type specified at last selected hex
+;<nowiki>:unit</nowiki> ''attribute=value''
+:when a unit is selected, this will set the unit's ''attribute'' to ''value''.   See [[SingleUnitWML]] for possible values.
 == See Also ==