Blam::API Namespace Reference

Namespace containing the Blamite Engine API. More...

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

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.

GetDirectorPosition()

BlamVector3 Blam::API::GetDirectorPosition

(

)

Retrieves the current position of the debug director.

Returns

The 3D position of the debug director.

GetDirectorSpeed()

float Blam::API::GetDirectorSpeed

(

)

Retrieves the current speed of the debug director.

Returns

The speed multiplier of the debug director.

GetMousePosition2D()

BlamVector2 Blam::API::GetMousePosition2D

(

)

Retrieves the 2D position of the mouse pointer.

Returns

The 2D position of the mouse pointer.

GetMousePosition3D()

BlamVector3 Blam::API::GetMousePosition3D

(

)

Retrieves the 3D position of the mouse pointer.

Returns

The 3D position of the mouse pointer.

Todo:

Implement.

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.

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.