BlamEngineExtension Class Reference

Class representing a Blamite Engine Extension. More...

#include <extensions.h>

Public Member Functions
BlamResult	LoadCallbacks ()
	Loads all required callbacks for the extension. More...
void	LoadOptionalCallbacks ()
	Loads all optional callbacks for the extension. More...
void	OnEnable ()
	Called when the extension is enabled. More...
void	OnDisable ()
	Called when the extension is disabled. More...
void	TagPostprocess (BlamTagData *tag_data)
	Optional extension function. More...
bool	TagNeedsPostprocess (BlamTagData *tag_data)
	Optional extension function. More...
void	LoadTagClasses ()
	Optional extension function. More...

Public Attributes
std::string	file_path = ""
	The file path to the extension file. More...
std::string	name = ""
	The name of the extension. More...
std::string	version = ""
	The version of the extension. More...
std::string	author = ""
	The author of the extension. More...
std::string	url = ""
	A website URL where users can learn more about the extension (such as checking for updates). More...
HMODULE	extension_handle = nullptr

Detailed Description

Class representing a Blamite Engine Extension.

See the Blam::Extensions namesapce for information on extensions.

Member Function Documentation

LoadCallbacks()

BlamResult BlamEngineExtension::LoadCallbacks

(

)

Loads all required callbacks for the extension.

This method will ensure that all required functions are loaded from the extension's DLL.

Returns

BlamResult::Success_OK if all required callbacks were loaded, otherwise returns an error code. If this method fails, the extension should not be loaded.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadOptionalCallbacks()

void BlamEngineExtension::LoadOptionalCallbacks

(

)

Loads all optional callbacks for the extension.

In some cases, extensions may want to implement non-required functions for more specific functionality. This method will load as many of these functions as possible. If any functions are not found, they are simply not called - as they aren't required for extension functionality.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadTagClasses()

void BlamEngineExtension::LoadTagClasses

(

)

Optional extension function.

Called after all built-in tag classes are registered, allowing the extension to register its own custom tag classes.

OnDisable()

void BlamEngineExtension::OnDisable

(

)

Called when the extension is disabled.

Here is the caller graph for this function:

OnEnable()

void BlamEngineExtension::OnEnable

(

)

Called when the extension is enabled.

Here is the caller graph for this function:

TagNeedsPostprocess()

bool BlamEngineExtension::TagNeedsPostprocess

(

BlamTagData *

tag_data

)

Optional extension function.

Called when checking if a tag requires post-processing. If this function returns true for any given tag, then the TagPostprocess function will be called afterwards.

Parameters

tag_data

- The tag data to post-process.

Returns

true if the specified tag should be post-processed within this extension, otherwise returns false.

TagPostprocess()

void BlamEngineExtension::TagPostprocess

(

BlamTagData *

tag_data

)

Optional extension function.

Called after engine tag postprocessing is complete, if the tag was marked as needing post-processing by this extension.

Parameters

tag_data

- The tag data to post-process.

Member Data Documentation

author

std::string BlamEngineExtension::author = ""

The author of the extension.

extension_handle

HMODULE BlamEngineExtension::extension_handle = nullptr

file_path

std::string BlamEngineExtension::file_path = ""

The file path to the extension file.

name

std::string BlamEngineExtension::name = ""

The name of the extension.

url

std::string BlamEngineExtension::url = ""

A website URL where users can learn more about the extension (such as checking for updates).

version

std::string BlamEngineExtension::version = ""

The version of the extension.

---

The documentation for this class was generated from the following files:

• blam/components/core/extensions/extensions.h
• blam/components/core/extensions/BlamEngineExtension.cpp