(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / console_type.h
blob18da4131db09f68cb3042cdd0fae3158c2fbd025
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8 */
10 /** @file console_type.h Globally used console related types. */
12 #ifndef CONSOLE_TYPE_H
13 #define CONSOLE_TYPE_H
15 #include "gfx_type.h"
17 /** Modes of the in-game console. */
18 enum IConsoleModes {
19 ICONSOLE_FULL, ///< In-game console is closed.
20 ICONSOLE_OPENED, ///< In-game console is opened, upper 1/3 of the screen.
21 ICONSOLE_CLOSED, ///< In-game console is opened, whole screen.
24 /* Colours of the console messages. */
25 static const TextColour CC_DEFAULT = TC_SILVER; ///< Default colour of the console.
26 static const TextColour CC_ERROR = TC_RED; ///< Colour for error lines.
27 static const TextColour CC_WARNING = TC_LIGHT_BLUE; ///< Colour for warning lines.
28 static const TextColour CC_INFO = TC_YELLOW; ///< Colour for information lines.
29 static const TextColour CC_DEBUG = TC_LIGHT_BROWN; ///< Colour for debug output.
30 static const TextColour CC_COMMAND = TC_GOLD; ///< Colour for the console's commands.
31 static const TextColour CC_WHITE = TC_WHITE; ///< White console lines for various things such as the welcome.
33 #endif /* CONSOLE_TYPE_H */