CConsole Class Reference
CConsole is a class which provides a console window besides the main game window. More...
#include <CConsole.h>
Public Member Functions | |
| CConsole () | |
| ~CConsole () | |
| void | Open (void) |
| Open the console window. | |
| void | Close (void) |
| Close the console window. | |
| void | Write (const char *pMessage,...) |
| Write a formatted string to the console. | |
| bool | IsOpen (void) |
| Returns whether the console window is opened. | |
| void | SetTextColor (WORD Color) |
| Set the color to use when writing text to the console. | |
| WORD | GetTextColor (void) |
| Get the color to use when writing text to the console. | |
| void | SetFilterRepeatedMessages (bool Filter) |
| Tell whether consecutive identical messages should be filtered or not. | |
Static Public Member Functions | |
| static CConsole & | GetConsole (void) |
| Get the console singleton. | |
Private Attributes | |
| HANDLE | m_StdOut |
| Handle to console output. | |
| bool | m_Open |
| Is the console opened? | |
| WORD | m_Color |
| Current text color (background/foreground). | |
| char | m_Message [2048] |
| Last message written to the console. | |
| int | m_NumberOfRepeatedMessages |
| How many consecutive identical messages have been sent? | |
| bool | m_FilterRepeatedMessage |
| Should we manage message repetition by not displaying all consecutive identical messages? | |
Detailed Description
CConsole is a class which provides a console window besides the main game window.Constructor & Destructor Documentation
| CConsole::CConsole | ( | ) |
| CConsole::~CConsole | ( | ) |
Here is the call graph for this function:
Member Function Documentation
| CConsole & CConsole::GetConsole | ( | void | ) | [static] |
Get the console singleton.
| void CConsole::Open | ( | void | ) |
Open the console window.
| void CConsole::Close | ( | void | ) |
Close the console window.
Here is the caller graph for this function:
| void CConsole::Write | ( | const char * | pMessage, | |
| ... | ||||
| ) |
Write a formatted string to the console.
| bool CConsole::IsOpen | ( | void | ) | [inline] |
Returns whether the console window is opened.
| void CConsole::SetTextColor | ( | WORD | Color | ) | [inline] |
Set the color to use when writing text to the console.
| WORD CConsole::GetTextColor | ( | void | ) | [inline] |
Get the color to use when writing text to the console.
| void CConsole::SetFilterRepeatedMessages | ( | bool | Filter | ) | [inline] |
Tell whether consecutive identical messages should be filtered or not.
Member Data Documentation
HANDLE CConsole::m_StdOut [private] |
Handle to console output.
bool CConsole::m_Open [private] |
Is the console opened?
WORD CConsole::m_Color [private] |
Current text color (background/foreground).
char CConsole::m_Message[2048] [private] |
Last message written to the console.
int CConsole::m_NumberOfRepeatedMessages [private] |
How many consecutive identical messages have been sent?
bool CConsole::m_FilterRepeatedMessage [private] |
Should we manage message repetition by not displaying all consecutive identical messages?
The documentation for this class was generated from the following files:
