Elaztek Developer Hub
Blamite Game Engine - blam!  00346.12.11.21.0529.blamite
The core library for the Blamite Game Engine.
Blam::Resources::DebugMenu Namespace Reference

Namespace containing data for the engine's debug menu. More...

Functions

BLAM void InitializeDebugMenu ()
 Initializes the debug menu. More...
 
BLAM void ReleaseDebugMenu ()
 Releases all debug menu contents. More...
 
BLAM void ReloadDebugMenu ()
 Clears all existing data for the debug menu and reloads it from the file. More...
 
BLAM BlamDebugMenuGetDebugMenu ()
 Retrieves the debug menu data. More...
 

Detailed Description

Namespace containing data for the engine's debug menu.

Function Documentation

◆ GetDebugMenu()

BlamDebugMenu * Blam::Resources::DebugMenu::GetDebugMenu ( )

Retrieves the debug menu data.

Returns
Pointer to the debug menu data.

◆ InitializeDebugMenu()

void Blam::Resources::DebugMenu::InitializeDebugMenu ( )

Initializes the debug menu.

This function will try and load a file with the .xml extension first. If that isn't found, it will attempt to load a file with the .txt extension as an XML file as a fallback. Ideally, we would have proper support for the original debug menu file format - and it probably wouldn't be that hard, really. The original debug menu is almost XML, but has a few key points where it breaks away from the standard.

As a result, virtually any attempt to load a legacy debug_menu_init.txt will fail. Hopefully at some point, we can build a proper interpreter to load those old files again.

Todo:
Implement support for debug_menu_init.txt

◆ ReleaseDebugMenu()

void Blam::Resources::DebugMenu::ReleaseDebugMenu ( )

Releases all debug menu contents.

The debug menu will be invalid once this is called.

◆ ReloadDebugMenu()

void Blam::Resources::DebugMenu::ReloadDebugMenu ( )

Clears all existing data for the debug menu and reloads it from the file.