Crazy Eddies GUI System  0.7.7
Public Member Functions | List of all members
CEGUI::ScriptException Class Reference

Exception class used for issues in scripting subsystem. More...

+ Inheritance diagram for CEGUI::ScriptException:
+ Collaboration diagram for CEGUI::ScriptException:

Public Member Functions

 ScriptException (const String &message, const String &file="unknown", int line=0)
 Constructor that is responsible for logging the script exception by calling the base class. More...
 
- Public Member Functions inherited from CEGUI::Exception
virtual ~Exception (void) throw ()
 Virtual destructor.
 
const StringgetMessage (void) const
 Return a reference to the String object describing the reason for the exception being thrown. More...
 
const StringgetName () const
 Return a reference to the String object containing the exception name (i.e. class type). More...
 
const StringgetFileName (void) const
 Return a reference to the String object containing the name of the file where the exception occurred. More...
 
int getLine (void) const
 Return the line number where the exception occurred. More...
 
const char * what () const throw ()
 

Additional Inherited Members

- Protected Member Functions inherited from CEGUI::Exception
 Exception (const String &message="", const String &name="CEGUI::Exception", const String &filename="", int line=0)
 Protected constructor that prevents instantiations (users should employ derived exception classes instead) and that is responsible for logging the exception. More...
 
- Protected Attributes inherited from CEGUI::Exception
String d_message
 Holds the reason for the exception being thrown.
 
String d_filename
 Holds the name of the file where the exception occurred.
 
String d_name
 Holds the class name of the exception (e.g. CEGUI::ObjectInUseException)
 
int d_line
 Holds the line number where the exception occurred.
 
String d_what
 Holds the default error message.
 

Detailed Description

Exception class used for issues in scripting subsystem.

Constructor & Destructor Documentation

CEGUI::ScriptException::ScriptException ( const String message,
const String file = "unknown",
int  line = 0 
)
inline

Constructor that is responsible for logging the script exception by calling the base class.

Parameters
messageString object describing the reason for the script exception being thrown.
filenameString object containing the name of the file where the script exception occurred.
lineInteger representing the line number where the script exception occurred.
Remarks
The script exception name is automatically passed to the base class as "CEGUI::ScriptException".