OpenBlox
A game engine which provides a simple and easy to learn Lua API.
OB::OBException Class Reference

#include <OBException.h>

Public Member Functions

 OBException ()
 
 OBException (std::string string)
 
virtual ~OBException ()
 
std::string getMessage ()
 
void raise ()
 
 operator std::string () const
 

Detailed Description

The general purpose exception class of the OpenBlox game engine.

Author
John M. Harris, Jr.

Constructor & Destructor Documentation

◆ OBException() [1/2]

OB::OBException::OBException ( )

Creates an OBException with no message.

Author
John M. Harris, Jr.

◆ OBException() [2/2]

OB::OBException::OBException ( std::string  string)

Creates an OBException with the message defined by the parameter "what"

Parameters
stringThe message to be associated with this exception.
Author
John M. Harris, Jr.

◆ ~OBException()

virtual OB::OBException::~OBException ( )
virtual

Member Function Documentation

◆ getMessage()

std::string OB::OBException::getMessage ( )

Returns the message of this OBException.

Returns
The message of this OBException
Author
John M. Harris, Jr.

◆ operator std::string()

OB::OBException::operator std::string ( ) const
inline

Attempts to cast this to a string return the same as getMessage.

Author
John M. Harris, Jr.

◆ raise()

void OB::OBException::raise ( )

Convenience function to throw this exception.

Author
John M. Harris, Jr.

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