Angel 3.2
A 2D Game Prototyping Engine
Public Member Functions | List of all members
TestConsole Class Reference

An example Console implementation. More...

#include <Console.h>

+ Inheritance diagram for TestConsole:

Public Member Functions

 TestConsole ()
 
virtual void Execute (String input)
 
virtual StringList GetCompletions (const String &input)
 
- Public Member Functions inherited from Console
 Console ()
 
virtual ~Console ()
 
void Render ()
 
void Update (float)
 
void Enable (bool bEnable=true)
 
bool IsEnabled ()
 
bool GetInput (int key)
 
bool GetSpecialInputDown (int key)
 
void ToggleConsole ()
 
unsigned char GetToggleConsoleKey ()
 
void WriteToOutput (String output)
 
void SetPrompt (const String &prompt)
 
const unsigned int GetTabWidth ()
 
void SetTabWidth (unsigned int newTabWidth)
 
void AdvanceInputHistory (int byVal)
 
void AcceptAutocomplete ()
 

Additional Inherited Members

- Protected Member Functions inherited from Console
bool IsTextKey (unsigned char key)
 
void AcceptCurrentInput ()
 
- Protected Attributes inherited from Console
String _currentInput
 
StringList _inputHistory
 
int _inputHistoryPos
 
String _prompt
 
StringList _buffer
 
String _unsplitBuffer
 
float _lineHeight
 
StringList _autoCompleteList
 
int _cursorPos
 
unsigned int _tabWidth
 

Detailed Description

A degenerate case of a Console; does nothing but echo the user input back into the screen log.

Definition at line 220 of file Console.h.

Constructor & Destructor Documentation

TestConsole::TestConsole ( )
inline

Sets up the prompt (::>);

Definition at line 226 of file Console.h.

Member Function Documentation

virtual void TestConsole::Execute ( String  input)
inlinevirtual

Echos the input right back out.

Parameters
inputThe string to echo

Implements Console.

Definition at line 236 of file Console.h.

virtual StringList TestConsole::GetCompletions ( const String &  input)
inlinevirtual

Returns an empty StringList.

Parameters
inputThe input to be ignored
Returns
An empty list

Implements Console.

Definition at line 244 of file Console.h.


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