BlamStrings Namespace Reference

Namespace for Blamite's shared C++ library. More...

Namespaces
	Converters
	Namespace containing functions to convert between various types of variables.
	Hooks
	Interface
	Logger
	Namespace containing functions for the unified logger.
	Resources
	Settings
	Utils
	Namespace containing general-purpose utilities.

Functions
const STRINGS_API char *	GetStringFromID (int string_id, int max_length)
	Retrieves a string from its ID. More...
STRINGS_API HMODULE	GetStringsDLLHandle ()
	Retrieves the module handle for the Strings library. More...
STRINGS_API BlamVersion	GetVersion ()
	Retrieves the current version of Strings. More...

Detailed Description

Namespace for Blamite's shared C++ library.

This namespace contains everything within the library that is publicly usable. It acts as a general purpose utility and resource library used by both the game engine and the various tools that use it.

Function Documentation

GetStringFromID()

const char * BlamStrings::GetStringFromID	(	int	string_id,
		int	max_length
	)

Retrieves a string from its ID.

Parameters

string_id	- The ID of the string within the DLL's string table.
max_length	- The maximum length of the string to retrieve. The source string will be trimmed if it is longer than this. If it is the same or longer than the source string, the entire string will be returned.

Returns

The string if it was provided, or nullptr if no matching string was found.

Deprecated:

Win32 string tables should be avoided going forward. Use another method of storing strings.

GetStringsDLLHandle()

HMODULE BlamStrings::GetStringsDLLHandle

(

)

Retrieves the module handle for the Strings library.

Returns

The Strings.dll module handle.

GetVersion()

BlamVersion BlamStrings::GetVersion

(

)

Retrieves the current version of Strings.

Returns

The current version of Strings.