IC_Console Class Reference

A Quake Like console class. More...

#include <console.h>

Inheritance diagram for IC_Console:

IC_MessageSink

List of all members.

Public Member Functions

 IC_Console (lua_State *L)
 constructor
virtual ~IC_Console ()
 destructor
IC_ConsoleConfiggetConfig ()
 get the console config reference
void initializeConsole (irr::IrrlichtDevice *device)
 (re)initialize the console with current config
void loadDefaultCommands (irr::IrrlichtDevice *device)
 loads a few default commands into the console
bool isVisible ()
 should console be visible
void setVisible (bool bV)
 set the visibility of the console
void toggleVisible ()
 toggle the visibility of the console
void appendMessage (const stringw message)
 add a unicode message to the sink
void clearMessages ()
 clear all the messages in the sink
void renderConsole (irr::gui::IGUIEnvironment *guienv, irr::video::IVideoDriver *videoDriver, const u32 deltaMillis)
 render the console (it internally checks if the console is visible)
void handleKeyPress (wchar_t keyChar, irr::EKEY_CODE keyCode, bool bShiftDown, bool bControlDown)
 handles a key press when console is active/visible

Static Public Attributes

static const wchar_t IC_KEY_TILDE = 0xc0
 the tilde (~/`) key


Detailed Description

A Quake Like console class.

Definition at line 171 of file console.h.


Constructor & Destructor Documentation

IC_Console::IC_Console ( lua_State *  L  ) 

constructor

Definition at line 76 of file console.cpp.

virtual IC_Console::~IC_Console (  )  [inline, virtual]

destructor

Definition at line 180 of file console.h.


Member Function Documentation

void IC_Console::appendMessage ( const stringw  message  )  [virtual]

add a unicode message to the sink

Implements IC_MessageSink.

Definition at line 157 of file console.cpp.

void IC_Console::clearMessages (  )  [virtual]

clear all the messages in the sink

Implements IC_MessageSink.

Definition at line 165 of file console.cpp.

IC_ConsoleConfig& IC_Console::getConfig (  )  [inline]

get the console config reference

Definition at line 184 of file console.h.

void IC_Console::handleKeyPress ( wchar_t  keyChar,
irr::EKEY_CODE  keyCode,
bool  bShiftDown,
bool  bControlDown 
)

handles a key press when console is active/visible

Definition at line 233 of file console.cpp.

void IC_Console::initializeConsole ( irr::IrrlichtDevice *  device  ) 

(re)initialize the console with current config

Definition at line 89 of file console.cpp.

bool IC_Console::isVisible (  ) 

should console be visible

Definition at line 136 of file console.cpp.

void IC_Console::loadDefaultCommands ( irr::IrrlichtDevice *  device  ) 

loads a few default commands into the console

Definition at line 113 of file console.cpp.

void IC_Console::renderConsole ( irr::gui::IGUIEnvironment *  guienv,
irr::video::IVideoDriver *  videoDriver,
const u32  deltaMillis 
)

render the console (it internally checks if the console is visible)

Definition at line 172 of file console.cpp.

void IC_Console::setVisible ( bool  bV  ) 

set the visibility of the console

Definition at line 143 of file console.cpp.

void IC_Console::toggleVisible (  )  [virtual]

toggle the visibility of the console

Implements IC_MessageSink.

Definition at line 150 of file console.cpp.


Member Data Documentation

const wchar_t IC_Console::IC_KEY_TILDE = 0xc0 [static]

the tilde (~/`) key

Definition at line 174 of file console.h.


The documentation for this class was generated from the following files:

Generated on Thu Jul 30 07:18:41 2009 for Cerberus by  doxygen 1.5.9