Namespace surrounding all major engine components. More...

Namespaces
	Animation
	Namespace for animation data.

	API
	Namespace containing the Blamite Engine API.

	Cache
	Namespace containing functions related to caching.

	Config
	Namespace for legacy configuration compatiability.

	Content

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

	DebugUI
	Namespace containing things relating to ImGUI, and the ImGUI draw list.

	Diagnostics
	Namespace containing things related to engine diagnostics, profiling, error handling, and logging.

	DialogHelpers
	Namespace containing helper functions for Win32 dialogs.

	Dialogs
	Namespace containing things related to the displaying of Win32 dialogs.

	Director
	Namespace for things related to the debug camera (director).

	DiscordRPC
	Namespace containing things related to Discord Rich Presence.

	EngineDefs
	Namespace containing core engine information.

	EngineResources
	Namespace for things related to game engine resources.

	EngineText
	Namespace for things related to game engine strings.

	Error
	Namespace containing things relating to Error information and reporting.

	Extensions
	Namespace containing functions for extensions.

	Globals
	Namespace containing things relating to game engine globals.

	Input

	InteropAPI
	Namespace containing functions relating to the Blamite C# Interoperability API.

	Logger
	Namespace containing things related to the Blamite Logger.

	Modules

	Network
	Namespace containing things related to networking.

	Placeholders
	Namespace containing things related to the Placeholders system.

	Reader

	Resources

	Sentry
	Namespace for things relating to Sentry.

	Settings

	Tick
	Namespace containing components relating to the game tick.

	UI
	Namespace containing functions relating to the Blamite UI system.

	User
	TBA.

	Utils
	Namespace containing general-purpose utilities.

	World
	Namespace containing functions for interacting with the current world state.

	Writer

Classes
class	command_object
	Legacy class representing a CommandScript command. More...

struct	Endpoint

struct	LinearAllocator

struct	Socket

Functions
BLAM bool	GetEngineHookState ()
	Retrieves the engine's hook state. More...

BLAM command_object	CreateCommandFromFile (std::string filename)

BLAM std::string	get_csc_cmd_name (std::string filename)

BLAM std::string	csc_var_process (std::string const &s)

BLAM std::string	csc_var_process (std::string const &s, char read_until)

BLAM void	Assert (const char expression, const char file, int line)
	Forces an engine assertion failure, and shows the crash screen. More...

BLAM void	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	linearAllocCreate (Blam::LinearAllocator *alloc, UINT64 size)

BLAM UINT8 *	linearAlloc (Blam::LinearAllocator *alloc, UINT64 size)

BLAM void	TakeScreenshot ()
	Captures the current frame and saves it to a file. More...

BLAM BlamRuntimeConfiguration	GetCurrentRuntimeConfig ()
	Retrieves the current runtime configuration. More...

BLAM BlamContentSource	GetContentSource ()
	Retrieves the current content source. More...

BLAM void	LogEventLegacy (const char *message)
	Legacy function to add a message to console. More...

BLAM void	SetConsoleState (bool state)
	Legacy function to control legacy ImGUI console visibility. More...

BLAM bool	GetConsoleState ()
	Legacy function to retrieve legacy ImGUI console visibility. More...

BLAM void	SetConsoleState2 (bool state)
	i have no idea why this exists More...

BLAM bool	GetConsoleState2 ()
	i have no idea why this exists More...

BLAM void	SetConsoleCommand2 (std::string command)
	i have no idea why this exists More...

BLAM std::string	GetConsoleCommand2 ()
	i have no idea why this exists More...

BLAM HWND	GetWin32MainWindowHandle ()
	Retrieves the main window handle of the application. More...

BLAM HMODULE	GetEngineDLLHandle ()
	Retrieves the module handle for the engine. More...

BLAM SDL_Window *	GetMainWindowHandle ()
	Retrieves the main window handle of the application, when using SDL. More...

Detailed Description

Namespace surrounding all major engine components.

Function Documentation

◆ Assert() [1/2]

void Blam::Assert	(	const char *	expression,
		const char *	file,
		int	line
	)

Forces an engine assertion failure, and shows the crash screen.

This function should NOT be called directly - use the BLAM_ASSERT macro instead.

Parameters

exc	- 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.

Here is the call graph for this function:

◆ Assert() [2/2]

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.

This function should NOT be called directly - use the BLAM_ASSERTM macro instead.

Parameters

exc	- 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.
message	- A message shown to the user containing any additional related information.

Here is the call graph for this function:

◆ CreateCommandFromFile()

Blam::command_object Blam::CreateCommandFromFile ( std::string filename )

Deprecated:: Old and shit.

Will be removed in the near future.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ csc_var_process() [1/2]

std::string Blam::csc_var_process ( std::string const & s )

Deprecated:: Old and shit.

Will be removed in the near future.

Here is the caller graph for this function:

◆ csc_var_process() [2/2]

std::string Blam::csc_var_process	(	std::string const &	s,
		char	read_until
	)

Deprecated:: Old and shit.

Will be removed in the near future.

◆ get_csc_cmd_name()

std::string Blam::get_csc_cmd_name ( std::string filename )

Deprecated:: Old and shit.

Will be removed in the near future.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetConsoleCommand2()

std::string Blam::GetConsoleCommand2 ( )

i have no idea why this exists

Deprecated:: Will be removed alongside the removal of the legacy ImGUI console.

Here is the caller graph for this function:

◆ GetConsoleState()

bool Blam::GetConsoleState ( )

Legacy function to retrieve legacy ImGUI console visibility.

Deprecated:: Will be removed alongside the removal of the legacy ImGUI console.

◆ GetConsoleState2()

bool Blam::GetConsoleState2 ( )

i have no idea why this exists

Deprecated:: Will be removed alongside the removal of the legacy ImGUI console.

◆ GetContentSource()

BlamContentSource Blam::GetContentSource ( )

Retrieves the current content source.

When running under different runtime configurations, the engine will load content from loose tag files, or from cache files. For cases where we don't need the exact runtime configuration and simply need to know how to load content, we can use this as an easier check.

Returns: The current content source.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCurrentRuntimeConfig()

BlamRuntimeConfiguration Blam::GetCurrentRuntimeConfig ( )

Retrieves the current runtime configuration.

The value of this will depend on the configuration used to compile the engine. See BlamRuntimeConfiguration for details.

Returns: The current runtime configuration.

Here is the caller graph for this function:

◆ GetEngineDLLHandle()

HMODULE Blam::GetEngineDLLHandle ( )

Retrieves the module handle for the engine.

Here is the caller graph for this function:

◆ GetEngineHookState()

bool Blam::GetEngineHookState ( )

Retrieves the engine's hook state.

In the event that we need to tweak engine behavior based on whether or not the engine is hooked into Qt (ie, when the engine is being displayed in a viewport within the editor), we can use this as a way to check whether or not the engine is hooked.

Returns: true if Qt is hooked, otherwise returns false.

Here is the caller graph for this function:

◆ GetMainWindowHandle()

SDL_Window * Blam::GetMainWindowHandle ( )

Retrieves the main window handle of the application, when using SDL.

Here is the caller graph for this function:

◆ GetWin32MainWindowHandle()

HWND Blam::GetWin32MainWindowHandle ( )

Retrieves the main window handle of the application.

Deprecated:: This returns the native window handle that the engine is using as its primary display, and should only be used in cases where the native window handle is absolutely needed. Whenever possible, please use Blam::GetMainWindowHandle instead.

Note: Formerly named Blam::GetMainWindowHandle, was renamed as SDL is now used for window creation instead.

Here is the caller graph for this function:

◆ linearAlloc()

UINT8 * Blam::linearAlloc	(	Blam::LinearAllocator *	alloc,
		UINT64	size
	)

Here is the caller graph for this function:

◆ linearAllocCreate()

void Blam::linearAllocCreate	(	Blam::LinearAllocator *	alloc,
		UINT64	size
	)

Here is the caller graph for this function:

◆ LogEventLegacy()

void Blam::LogEventLegacy ( const char * message )

Legacy function to add a message to console.

Was written before the Logger was implemented, and as such doesn't communicate with the logger in any way.

Deprecated:: Will be removed alongside the removal of the legacy ImGUI console.

◆ SetConsoleCommand2()

void Blam::SetConsoleCommand2 ( std::string command )

i have no idea why this exists

Deprecated:: Will be removed alongside the removal of the legacy ImGUI console.

◆ SetConsoleState()

void Blam::SetConsoleState ( bool state )

Legacy function to control legacy ImGUI console visibility.

Parameters

state - Whether or not to make the console visibile.

Deprecated:: Will be removed alongside the removal of the legacy ImGUI console.

Here is the call graph for this function:

◆ SetConsoleState2()

void Blam::SetConsoleState2 ( bool state )

i have no idea why this exists

Deprecated:: Will be removed alongside the removal of the legacy ImGUI console.

◆ TakeScreenshot()

void Blam::TakeScreenshot ( )

Captures the current frame and saves it to a file.

Deprecated:: Only works under DirectX 11, and will be removed when the standalone DirectX renderer is removed.

Here is the caller graph for this function:

Namespaces

Classes

Functions

Detailed Description

Function Documentation

◆ Assert() [1/2]

◆ Assert() [2/2]

◆ CreateCommandFromFile()

◆ csc_var_process() [1/2]

◆ csc_var_process() [2/2]

◆ get_csc_cmd_name()

◆ GetConsoleCommand2()

◆ GetConsoleState()

◆ GetConsoleState2()

◆ GetContentSource()

◆ GetCurrentRuntimeConfig()

◆ GetEngineDLLHandle()

◆ GetEngineHookState()

◆ GetMainWindowHandle()

◆ GetWin32MainWindowHandle()

◆ linearAlloc()

◆ linearAllocCreate()

◆ LogEventLegacy()

◆ SetConsoleCommand2()

◆ SetConsoleState()

◆ SetConsoleState2()

◆ TakeScreenshot()