In file include/cstools/simpcons.h:

## class csSimpleConsole : public csConsole

> The console

## Inheritance:

### Public Methods

void AddChar(int c)
  A character key has been pressed
virtual void Clear()
  Clear console
csSimpleConsole(csSimpleCommand* = 0)
  Create console object
virtual void ExecuteCommand(char *command)
  Print (if console is active) and execute a command
int get_bg()
  Get the background color
int get_fg()
  Get the foreground color
virtual void Hide()
  Hide the console
virtual bool IsActive()
  Return true if console is active
bool IsTransparent()
  Test if the console is transparent and if we should allow the renderer to draw
virtual void Print(csRect* area)
  Refresh console image
void PutMessage(bool advance, char *str, ...)
  Add a text line to message console (overlapped on rendering screen)
virtual void PutText(char *str, ...)
  Add a text line to main console window
void SetMaxLines(int ml = -1)
  Set the maximum number of lines (-1 = read from config file)
void SetTransparent(int t = -1)
  Set transparency mode for console
void SetupColors(ITextureManager* txtmgr)
  Recalculate console colors
virtual void Show()
  Show the console
virtual ~csSimpleConsole()
  Destroy console object

### Protected Fields

csSimpleCommand* command_handler
  The command handler
int console_bg
  Console background color
int console_bg_r
  RGB version of above
int console_fg
  Text foreground color
int console_fg_r
  RGB version of above
int console_font
  Select font (-1 = automatic, else one of cs_Font_...)
bool console_transparent_bg
  Transparent console background?
int ConsoleMode
  Console mode

### Private Fields

bool CursorState
  Cursor state
long CursorTime
  Cursor switch time
char** History
  History array
int HistoryCount
  Number of elements in history array
int HistoryCurrent
  Current position in history array
int HistoryMax
  Maximum history lines
char** Line
  Console contents
char* LineCommand
  Currently edited command line
int LineCommandCount
  Currently edited character
int LineCommandMax
  Maximal characters in edited line
int LineMax
  Maximum lines on console
char** LineMessage
  Messages overlapped onto renderer screen
int LineMessageMax
  Maximum lines on message pad
int LineMessageNumber
  Current output line on message pad
int LineNumber
  Current output line on console
bool* LinesChanged
  Lines changed since last 'Print'
int LineSize
  Characters per line
long LineTime
  Time left until messages will scroll up

### Inherited from csConsole:

### Inherited from csBase:

## Documentation

> The console

`int console_fg`
  Text foreground color

`int console_fg_r`
  RGB version of above

`int console_bg`
  Console background color

`int console_bg_r`
  RGB version of above

`bool console_transparent_bg`
  Transparent console background?

`int ConsoleMode`
  Console mode

`int console_font`
  Select font (-1 = automatic, else one of cs_Font_...)

`csSimpleCommand* command_handler`
  The command handler

`csSimpleConsole(csSimpleCommand* = 0)`
  Create console object

`virtual ~csSimpleConsole()`
  Destroy console object

`virtual bool IsActive()`
  Return true if console is active

`virtual void Show()`
  Show the console

`virtual void Hide()`
  Hide the console

`bool IsTransparent()`
  Test if the console is transparent and if we should allow the renderer to draw

`void SetTransparent(int t = -1)`
  Set transparency mode for console. 0 = off, 1 = on, -1 = read from config.

`int get_fg()`
  Get the foreground color

`int get_bg()`
  Get the background color

`void PutMessage(bool advance, char *str, ...)`
  Add a text line to message console (overlapped on rendering screen)

`virtual void PutText(char *str, ...)`
  Add a text line to main console window

`virtual void ExecuteCommand(char *command)`
  Print (if console is active) and execute a command

`virtual void Clear()`
  Clear console

`virtual void Print(csRect* area)`
  Refresh console image

`void AddChar(int c)`
  A character key has been pressed

`void SetupColors(ITextureManager* txtmgr)`
  Recalculate console colors

`void SetMaxLines(int ml = -1)`
  Set the maximum number of lines (-1 = read from config file)

`long LineTime`
  Time left until messages will scroll up

`bool CursorState`
  Cursor state

`long CursorTime`
  Cursor switch time

`char** Line`
  Console contents

`int LineNumber`
  Current output line on console

`int LineMax`
  Maximum lines on console

`int LineSize`
  Characters per line

`bool* LinesChanged`
  Lines changed since last 'Print'

`char** LineMessage`
  Messages overlapped onto renderer screen

`int LineMessageNumber`
  Current output line on message pad

`int LineMessageMax`
  Maximum lines on message pad

`char* LineCommand`
  Currently edited command line

`int LineCommandCount`
  Currently edited character

`int LineCommandMax`
  Maximal characters in edited line

`char** History`
  History array

`int HistoryCount`
  Number of elements in history array

`int HistoryMax`
  Maximum history lines

`int HistoryCurrent`
  Current position in history array

This class has no child classes.

alphabetic index hierarchy of classes

this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de