Class hierarchy Compound list File list Compound Members File Members
Console Class Reference
This is the main console class. More...
Inherits SystemInterface.
List of all members.
Public Members
- virtual Mouse* getMouse () = 0
- Returns pointer to the mouse object.
- virtual Keyboard* getKeyboard () = 0
- Returns pointer to the keyboard object.
- virtual Screen* getScreen () = 0
- Returns pointer to the screen object.
- virtual Screen3D* getScreen3D () = 0
- Returns pointer to the 3D Screen object.
- virtual Sound* getSound () = 0
- Returns pointer to the sound object, or NULL if not available.
- virtual Joystick* getJoystick () = 0
- Returns pointer to the joystick object, or NULL if not available.
- virtual long status () = 0
- Returns a non-zero value if an error occurred.
Related Functions
(Note that these are not member functions.)
- DLLExport float getVersion ()
- Returns the version of the library.
- DLLExport float getFrameTime ()
- Returns the Fraction frame time needed for a world's advance.
- DLLExport Console* getConsole ()
- Returns the Console object pointer.
- DLLExport void setDebugLevel (int Level)
- Sets the level of debugging information.
- DLLExport void enableDiagnostics ()
- Enable a mechanizm that tracks allocated interfaces.
- DLLExport void ReportError (long rc, const char* Message)
- Can be used to append the log file with an error message.
- DLLExport void ReportWarning (long rc, const char* Message, int MinDebug=1)
- Can be used to append the log file with an warning message.
- DLLExport void ReportInfo (const char* Message, int MinDebug=1)
- Can be used to append the log file with an informational message.
Detailed Description
This is the main console class.
A single object of this class will exist,
and will be passed as a parameter to the main action() routine.
Member Function Documentation
virtual Mouse* Console::getMouse() = 0 [pure virtual]
Returns pointer to the mouse object.
virtual Keyboard* Console::getKeyboard() = 0 [pure virtual]
Returns pointer to the keyboard object.
virtual Screen* Console::getScreen() = 0 [pure virtual]
Returns pointer to the screen object.
virtual Screen3D* Console::getScreen3D() = 0 [pure virtual]
Returns pointer to the 3D Screen object.
virtual Sound* Console::getSound() = 0 [pure virtual]
Returns pointer to the sound object, or NULL if not available.
virtual Joystick* Console::getJoystick() = 0 [pure virtual]
Returns pointer to the joystick object, or NULL if not available.
virtual long Console::status() = 0 [pure virtual]
Returns a non-zero value if an error occurred.
DLLExport float getVersion()
Returns the version of the library.
DLLExport float getFrameTime()
Returns the Fraction frame time needed for a world's advance.
DLLExport Console* getConsole()
Returns the Console object pointer.
DLLExport void setDebugLevel(int Level)
Sets the level of debugging information.
Defaults to 0 which outputs no log.
Setting to a different value will create a log file 'libcon.log'
That will be filled with printouts.
DLLExport void enableDiagnostics()
Enable a mechanizm that tracks allocated interfaces.
If used, it must be called before creating any interfaces.
Diagnosis will be printed (If the debug level is set) when
the program terminates. The printouts will contain the
types of interfaces that were not released.
DLLExport void ReportError(long rc, const char* Message)
Can be used to append the log file with an error message.
rc is a return code, or any informational number.
DLLExport void ReportWarning(long rc, const char* Message, int MinDebug=1)
Can be used to append the log file with an warning message.
rc is a return code, or any informational number.
DLLExport void ReportInfo(const char* Message, int MinDebug=1)
Can be used to append the log file with an informational message.
The documentation for this class was generated from the following files: