Blam::CrashScreen Namespace Reference

Namespace for the engine's crash screen and error handling. More...

Functions
BLAM void	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	ShowBasicCrashScreen ()
	Shows a basic crash screen to the user. More...
BLAM void	ShowSignalCrashScreen (int signal)
	Shows a basic crash screen to the user. More...

Detailed Description

Namespace for the engine's crash screen and error handling.

Function Documentation

ShowBasicCrashScreen()

void Blam::CrashScreen::ShowBasicCrashScreen

(

)

Shows a basic crash screen to the user.

Caused by an abort() call.

This function is called automatically if the user clicks 'Abort' when they are shown the standard abort() dialog. It will NOT be called if the user chooses 'Retry' to debug.

Parameters

signal

- The signal received, will usually be SIGABRT (22). For all signals, see signal.h (not part of engine source)

ShowDetailedCrashScreen()

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.

This function should NOT be called directly - use the BLAM_ASSERT macro instead. If the crash screen fails to display, an error dialog is shown instead.

Parameters

expression	- The value, function, or equation that failed to return true.
file	- The .cpp file that caused the assertion.
line	- The line number of the .cpp file that caused the assertion.
details	- A message shown to the user containing any additional related information.

ShowSignalCrashScreen()

void Blam::CrashScreen::ShowSignalCrashScreen

(

int

signal

)

Shows a basic crash screen to the user.

Caused by an abort() call.

This function is called automatically if the user clicks 'Abort' when they are shown the standard abort() dialog. It will NOT be called if the user chooses 'Retry' to debug.

Parameters

signal

- The signal received, will usually be SIGABRT (22). For all signals, see signal.h (not part of engine source)