OpenTTD Source: src/console_type.h File Reference

OpenTTD Source 15.0-beta1

Enumerations | Variables
console_type.h File Reference

Globally used console related types. More...

`#include "gfx_type.h"`

Go to the source code of this file.

## Enumerations
enum | IConsoleModes { ICONSOLE_FULL , ICONSOLE_OPENED , ICONSOLE_CLOSED }
| Modes of the in-game console. More...

## Variables
static const TextColour | CC_DEFAULT = TC_SILVER
| Default colour of the console.
static const TextColour | CC_ERROR = TC_RED
| Colour for error lines.
static const TextColour | CC_WARNING = TC_LIGHT_BLUE
| Colour for warning lines.
static const TextColour | CC_HELP = TC_LIGHT_BLUE
| Colour for help lines.
static const TextColour | CC_INFO = TC_YELLOW
| Colour for information lines.
static const TextColour | CC_DEBUG = TC_LIGHT_BROWN
| Colour for debug output.
static const TextColour | CC_COMMAND = TC_GOLD
| Colour for the console's commands.
static const TextColour | CC_WHITE = TC_WHITE
| White console lines for various things such as the welcome.

## Detailed Description

Globally used console related types.

Definition in file console_type.h.

## Enumeration Type Documentation

## ◆ IConsoleModes

enum IConsoleModes

Modes of the in-game console.

Enumerator
ICONSOLE_FULL | In-game console is opened, whole screen.
ICONSOLE_OPENED | In-game console is opened, upper 1/3 of the screen.
ICONSOLE_CLOSED | In-game console is closed.

Definition at line 16 of file console_type.h.

## Variable Documentation

## ◆ CC_COMMAND

const TextColour CC_COMMAND = TC_GOLD
| static

Colour for the console's commands.

Definition at line 29 of file console_type.h.

Referenced by IConsoleWindow::OnKeyPress(), IConsoleWindow::OnPaint(), and OutputContentState().

## ◆ CC_DEBUG

const TextColour CC_DEBUG = TC_LIGHT_BROWN
| static

Colour for debug output.

Definition at line 28 of file console_type.h.

Referenced by DebugSendRemoteMessages().

## ◆ CC_DEFAULT

const TextColour CC_DEFAULT = TC_SILVER
| static

Default colour of the console.

Definition at line 23 of file console_type.h.

Referenced by ServerNetworkGameSocketHandler::CloseConnection(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), NetworkClientsToSpectators(), NetworkHandlePauseChange(), NetworkServerChangeClientName(), NetworkUpdateClientName(), ConsoleContentCallback::OnConnect(), ConsoleContentCallback::OnDisconnect(), ConsoleContentCallback::OnDownloadComplete(), PrintLineByLine(), ServerNetworkGameSocketHandler::Receive_CLIENT_ERROR(), ServerNetworkGameSocketHandler::Receive_CLIENT_MAP_OK(), ServerNetworkGameSocketHandler::Receive_CLIENT_QUIT(), ServerNetworkGameSocketHandler::Receive_CLIENT_SET_NAME(), ClientNetworkGameSocketHandler::Receive_SERVER_CLIENT_INFO(), ClientNetworkGameSocketHandler::Receive_SERVER_ERROR_QUIT(), ClientNetworkGameSocketHandler::Receive_SERVER_JOIN(), ClientNetworkGameSocketHandler::Receive_SERVER_QUIT(), and ServerNetworkGameSocketHandler::SendError().

## ◆ CC_ERROR

const TextColour CC_ERROR = TC_RED
| static

Colour for error lines.

Definition at line 24 of file console_type.h.

Referenced by IConsole::AliasRegister(), ConPrintFramerate(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_HOOK(), DEF_CONSOLE_HOOK(), DEF_CONSOLE_HOOK(), DEF_CONSOLE_HOOK(), DEF_CONSOLE_HOOK(), DEF_CONSOLE_HOOK(), IConsoleAliasExec(), IConsoleCmdExec(), IConsoleGetSetting(), NetworkAvailable(), OutputContentState(), and ShowErrorMessage().

## ◆ CC_HELP

const TextColour CC_HELP = TC_LIGHT_BLUE
| static

Colour for help lines.

Definition at line 26 of file console_type.h.

Referenced by DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), IConsoleAliasExec(), and IConsoleListSettings().

## ◆ CC_INFO

const TextColour CC_INFO = TC_YELLOW
| static

Colour for information lines.

Definition at line 27 of file console_type.h.

Referenced by DEF_CONSOLE_CMD(), DEF_CONSOLE_CMD(), IConsoleGetSetting(), NetworkAutoCleanCompanies(), NetworkPrintClients(), NetworkServerShowStatusToConsole(), and OutputContentState().

## ◆ CC_WARNING

const TextColour CC_WARNING = TC_LIGHT_BLUE
| static

Colour for warning lines.

Definition at line 25 of file console_type.h.

Referenced by NetworkServer_Tick(), Gamelog::PrintConsole(), ServerNetworkGameSocketHandler::Receive_CLIENT_CHAT(), ServerNetworkGameSocketHandler::Receive_CLIENT_COMMAND(), ClientNetworkGameSocketHandler::Receive_SERVER_COMMAND(), and ShowErrorMessage().

## ◆ CC_WHITE

const TextColour CC_WHITE = TC_WHITE
| static

White console lines for various things such as the welcome.

Definition at line 30 of file console_type.h.

Referenced by OutputContentState().