Blam::API Namespace Reference

Namespace containing the Blamite Engine API. More...

Namespaces
	v1
	Namespace for version 1 of the Blamite Game Engine API.

Functions
BLAM_EXT_API void	SetEngineHookState (bool hook_state)
	Sets whether or not the engine is hooked via Qt. More...
BLAM_EXT_API void	ExecuteConsoleCommand (const char *command)
	Runs a command through the engine's console. More...
BLAM_EXT_API void	ResizeViewport (int width, int height)
	Resizes the engine's viewport resolution. More...
BLAM_EXT_API BlamVector3	GetDirectorPosition ()
	Retrieves the current position of the debug director. More...
BLAM_EXT_API float	GetDirectorSpeed ()
	Retrieves the current speed of the debug director. More...
BLAM_EXT_API BlamVector2	GetMousePosition2D ()
	Retrieves the 2D position of the mouse pointer. More...
BLAM_EXT_API BlamVector3	GetMousePosition3D ()
	Retrieves the 3D position of the mouse pointer. More...
BLAM_EXT_API void	SetEngineViewportActive (bool viewport_active)
	API wrapper around ImGui_ImplSDL2_SetActiveWindowOverride. More...
BLAM_EXT_API bool	IsMouseCapturedByDirector ()
	Checks if the mouse is currently captured by the debug director. More...
BLAM_EXT_API BlamVector2	GetGameResolution ()
	Retrieves the current render resolution for the engine. More...
BLAM_EXT_API BlamWorldState *	GetWorldState ()
	Retrieves the current world state. More...
BLAM_EXT_API BlamResult	LoadTagFromMemory (char *address, int size, const char *tag_path)

Detailed Description

Namespace containing the Blamite Engine API.

This is a general-purpose API, currently for use within the engine's toolset. This could be expanded to allow things like C# scripting or 3rd-party tools (though this is still a MAJOR 'if').

Function Documentation

ExecuteConsoleCommand()

void Blam::API::ExecuteConsoleCommand

(

const char *

command

)

Runs a command through the engine's console.

Parameters

command

- The command line input to execute.

Here is the call graph for this function:

GetDirectorPosition()

BlamVector3 Blam::API::GetDirectorPosition

(

)

Retrieves the current position of the debug director.

Returns

The 3D position of the debug director.

Here is the call graph for this function:

GetDirectorSpeed()

float Blam::API::GetDirectorSpeed

(

)

Retrieves the current speed of the debug director.

Returns

The speed multiplier of the debug director.

Here is the call graph for this function:

GetGameResolution()

BlamVector2 Blam::API::GetGameResolution

(

)

Retrieves the current render resolution for the engine.

Returns

The current resolution of the game engine.

Here is the call graph for this function:

GetMousePosition2D()

BlamVector2 Blam::API::GetMousePosition2D

(

)

Retrieves the 2D position of the mouse pointer.

Returns

The 2D position of the mouse pointer.

Here is the call graph for this function:

GetMousePosition3D()

BlamVector3 Blam::API::GetMousePosition3D

(

)

Retrieves the 3D position of the mouse pointer.

Returns

The 3D position of the mouse pointer.

Todo:

Implement.

GetWorldState()

BlamWorldState * Blam::API::GetWorldState

(

)

Retrieves the current world state.

Returns

Pointer to the current world state, or nullptr if the world state is not initialized.

Here is the call graph for this function:

IsMouseCapturedByDirector()

bool Blam::API::IsMouseCapturedByDirector

(

)

Checks if the mouse is currently captured by the debug director.

Returns

true if the mouse is captured, otherwise returns false.

Here is the call graph for this function:

LoadTagFromMemory()

BlamResult Blam::API::LoadTagFromMemory	(	char *	address,
		int	size,
		const char *	tag_path
	)

Here is the call graph for this function:

ResizeViewport()

void Blam::API::ResizeViewport	(	int	width,
		int	height
	)

Resizes the engine's viewport resolution.

Parameters

width	- The width of the viewport.
height	- The height of the viewport.

Here is the call graph for this function:

SetEngineHookState()

void Blam::API::SetEngineHookState

(

bool

hook_state

)

Sets whether or not the engine is hooked via Qt.

This should be called anytime the engine is initialized from Keystone.

Parameters

hook_state

- Whether or not Qt is hooked.

SetEngineViewportActive()

void Blam::API::SetEngineViewportActive

(

bool

viewport_active

)

API wrapper around ImGui_ImplSDL2_SetActiveWindowOverride.

Used to set the focused state of the engine viewport for capturing input. See the function listed above for details.

Parameters

viewport_active

- Whether or not the engine viewport is active.

Here is the call graph for this function: