summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2011-05-28 09:56:14 +0000
committeralberth <alberth@openttd.org>2011-05-28 09:56:14 +0000
commitc8cbc8ef97d115fcb74b609b5751298bdf52a24e (patch)
treeac32b0dc4aac99cf32a1e3c24ea755fe42e2412c
parent460d24fd83e6245684c2e4c7466382c2b93a02e0 (diff)
downloadopenttd-c8cbc8ef97d115fcb74b609b5751298bdf52a24e.tar.xz
(svn r22507) -Doc: Document SwitchMode.
-rw-r--r--src/openttd.h20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/openttd.h b/src/openttd.h
index 6646801e3..e6a04d4bb 100644
--- a/src/openttd.h
+++ b/src/openttd.h
@@ -24,16 +24,16 @@ enum GameMode {
/** Mode which defines what mode we're switching to. */
enum SwitchMode {
SM_NONE,
- SM_NEWGAME,
- SM_RESTARTGAME,
- SM_EDITOR,
- SM_LOAD,
- SM_MENU,
- SM_SAVE,
- SM_GENRANDLAND,
- SM_LOAD_SCENARIO,
- SM_START_HEIGHTMAP,
- SM_LOAD_HEIGHTMAP,
+ SM_NEWGAME, ///< New Game --> 'Random game'.
+ SM_RESTARTGAME, ///< Restart --> 'Random game' with current settings.
+ SM_EDITOR, ///< Switch to scenario editor.
+ SM_LOAD, ///< Load game, Play Scenario.
+ SM_MENU, ///< Switch to game intro menu.
+ SM_SAVE, ///< Save game.
+ SM_GENRANDLAND, ///< Generate random land within scenario editor.
+ SM_LOAD_SCENARIO, ///< Load scenario from scenario editor.
+ SM_START_HEIGHTMAP, ///< Load a heightmap and start a new game from it.
+ SM_LOAD_HEIGHTMAP, ///< Load heightmap from scenario editor.
};
/** Display Options */