OpenTTD Source: src/console_func.h Source File

OpenTTD Source 1.11.0-RC1

console_func.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #ifndef CONSOLE_FUNC_H
11 #define CONSOLE_FUNC_H
12
13 #include "console_type.h"
14
15 /* console modes */
16 extern IConsoleModes _iconsole_mode;
17
18 /* console functions */
19 void IConsoleInit();
20 void IConsoleFree();
21 void IConsoleClose();
22
23 /* console output */
24 void IConsolePrint(TextColour colour_code, const char *string);
25 void CDECL IConsolePrintF(TextColour colour_code, const char *format, ...) WARN_FORMAT(2, 3);
26 void IConsoleDebug(const char *dbg, const char *string);
27 void IConsoleWarning(const char *string);
28 void IConsoleError(const char *string);
29
30 /* Parser */
31 void IConsoleCmdExec(const char *cmdstr, const uint recurse_count = 0);
32
33 bool IsValidConsoleColour(TextColour c);
34
35 #endif /* CONSOLE_FUNC_H */
IConsolePrint
void IConsolePrint(TextColour colour_code, const char *string)
Handle the printing of text entered into the console or redirected there by any other means.
Definition: console.cpp:85
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
IConsoleError
void IConsoleError(const char *string)
It is possible to print error information to the console.
Definition: console.cpp:168
IConsoleModes
IConsoleModes
Modes of the in-game console.
Definition: console_type.h:16
console_type.h
IConsoleDebug
void CDECL void IConsoleDebug(const char *dbg, const char *string)
It is possible to print debugging information to the console, which is achieved by using this functio...
Definition: console.cpp:147
IsValidConsoleColour
bool IsValidConsoleColour(TextColour c)
Check whether the given TextColour is valid for console usage.
Definition: console_gui.cpp:523
IConsoleCmdExec
void IConsoleCmdExec(const char *cmdstr, const uint recurse_count=0)
Execute a given command passed to us.
Definition: console.cpp:407
IConsoleWarning
void IConsoleWarning(const char *string)
It is possible to print warnings to the console.
Definition: console.cpp:158
IConsoleClose
void IConsoleClose()
Close the in-game console.
Definition: console_gui.cpp:453
IConsolePrintF
void CDECL IConsolePrintF(TextColour colour_code, const char *format,...)
Handle the printing of text entered into the console or redirected there by any other means.
Definition: console.cpp:125