Blam::API::v1 Namespace Reference

Namespace for version 1 of the Blamite Game Engine API. More...

Namespaces
	Hooking
	Namespace containing functions for external engine hooking.
	HS
	Namespace containing functions available via the standard scripting engine.
	Logger
	Namespace containing functions used for diagnostic logging.
	Tags
	Namespace containing functions used for interacting with tags and tag classes.
	World

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

Detailed Description

Namespace for version 1 of the Blamite Game Engine API.

Function Documentation

ExecuteConsoleCommand()

void Blam::API::v1::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::v1::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::v1::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::v1::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::v1::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::v1::GetMousePosition3D

(

)

Retrieves the 3D position of the mouse pointer.

Returns

The 3D position of the mouse pointer.

Todo:

Implement.

IsMouseCapturedByDirector()

bool Blam::API::v1::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:

ResizeViewport()

void Blam::API::v1::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:

SetEngineViewportActive()

void Blam::API::v1::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: