Blamite Game Engine - blam!  00296.01.12.21.0102.blamite
The core library for the Blamite Game Engine.
crash.h File Reference
#include <string>

Go to the source code of this file.

Namespaces

 Blam
 Namespace surrounding all major engine components.
 
 Blam::CrashScreen
 Namespace for the engine's crash screen and error handling.
 
 Blam::Sentry
 Namespace for things relating to Sentry.
 

Macros

#define BLAM_ASSERT(x)   if (!(x)) Blam::Assert(#x, __FILE__, __LINE__)
 Invokes an engine assertion. More...
 
#define BLAM_ASSERTM(x, msg)   if (!(x)) Blam::Assert(#x, __FILE__, __LINE__, msg)
 Invokes an engine assertion, with an optional message. More...
 
#define BLAM
 

Enumerations

enum  SentryUploadStatus { Uploading }
 Enumerator for various Sentry upload states. More...
 

Functions

BLAM void Blam::Assert (const char *expression, const char *file, int line)
 Forces an engine assertion failure, and shows the crash screen. More...
 
BLAM void Blam::Assert (const char *expression, const char *file, int line, std::string message)
 Forces an engine assertion failure, and shows the crash screen, with additional details. More...
 
BLAM void Blam::CrashScreen::ShowDetailedCrashScreen (const char *expression, const char *file, int line, std::string details)
 Shows a detailed crash screen to the user, usually caused by an engine assertion. More...
 
BLAM void Blam::CrashScreen::ShowBasicCrashScreen ()
 Shows a basic crash screen to the user. More...
 
BLAM void Blam::CrashScreen::ShowSignalCrashScreen (int signal)
 Shows a basic crash screen to the user. More...
 
BLAM void Blam::Sentry::UploadCrashData ()
 
BLAM std::string Blam::Sentry::GetCrashUploadStateMessage ()
 Retrieves the state of the Sentry data upload. More...
 
BLAM std::string Blam::Sentry::GetEventID ()
 Retrieves the Event ID generated by Sentry, used to cross-reference bug reports and Sentry data. More...
 
BLAM void Blam::Sentry::StartSentry ()
 
BLAM void Blam::Sentry::ShutdownSentry ()
 

Macro Definition Documentation

◆ BLAM

#define BLAM

◆ BLAM_ASSERT

#define BLAM_ASSERT (   x)    if (!(x)) Blam::Assert(#x, __FILE__, __LINE__)

Invokes an engine assertion.

In general terms, an assertion is used to enforce a specific condition. In this function, if x is not true - be that an actual boolean or an equation test - then the engine will invoke an assertion failure.

Parameters
x- The value, function, or equation that should return true

◆ BLAM_ASSERTM

#define BLAM_ASSERTM (   x,
  msg 
)    if (!(x)) Blam::Assert(#x, __FILE__, __LINE__, msg)

Invokes an engine assertion, with an optional message.

In general terms, an assertion is used to enforce a specific condition. In this function, if x is not true - be that an actual boolean or an equation test - then the engine will invoke an assertion failure.

Parameters
x- The value, function, or equation that should return true
msg- A message shown to the user containing any additional related information.

Enumeration Type Documentation

◆ SentryUploadStatus

Enumerator for various Sentry upload states.

Enumerator
Uploading 

Used when prepared Sentry data is being uploaded to the server.