api.h File Reference

#include <string>
#include <map>
#include <blam/api/v1/types/world_objects.h>
#include <blam/api/v1/types/globals.h>
#include <Strings/components/resources/project_info/project_info.h>
#include <Strings/components/diagnostics/errors/errors.h>

Include dependency graph for api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::API
	Blam::API::v1
	Namespace for version 1 of the Blamite Game Engine API.
	Blam::API::v1::Project
	Blam::API::v1::Console
	Namespace containing functions for interacting with console commands.
	Blam::API::v1::Globals
	Namespace containing functions for interacting with engine globals.
	Blam::API::v1::Logger
	Namespace containing functions used for diagnostic logging.
	Blam::API::v1::Tags
	Namespace containing functions used for interacting with tags and tag classes.
	Blam::API::v1::World
	Blam::API::v1::HS
	Namespace containing functions available via the standard scripting engine.
	Blam::API::v1::Hooking
	Namespace containing functions for external engine hooking.

Macros
#define	BLAM_EXT_API   __declspec(dllimport)

Functions
BLAM_EXT_API void	Blam::API::v1::Project::SetCurrentProjectInfo (BlamProjectInfo project_info)
BLAM_EXT_API std::string	Blam::API::v1::Console::RegisterCommand (BlamConsoleCommand *command)
	Register a new command object. More...
BLAM_EXT_API bool	Blam::API::v1::Console::UnregisterCommand (std::string name)
	Unregisters the console command with the specified name. More...
BLAM_EXT_API BlamConsoleCommand	Blam::API::v1::Console::GetCommandInfo (std::string name)
	Retrieves a command with the specified name. More...
BLAM_EXT_API std::vector< std::string >	Blam::API::v1::Console::GetKnownCommands ()
	Retrieves a list of known console commands. More...
BLAM_EXT_API std::map< std::string, BlamEngineGlobal > *	Blam::API::v1::Globals::GetGlobalsList ()
	Retrieves the list of loaded globals. More...
BLAM_EXT_API std::string	Blam::API::v1::Globals::GetGlobalTypeLabel (BlamGlobalType type)
	Retrieves a string representation of a global's type, for use in UI. More...
BLAM_EXT_API bool	Blam::API::v1::Globals::GlobalExists (std::string id)
	Determines whether or not a global exists. More...
BLAM_EXT_API void	Blam::API::v1::Globals::RegisterGlobal (BlamEngineGlobal var)
	Registers a new engine global. More...
BLAM_EXT_API void	Blam::API::v1::Globals::RegisterGlobal (std::string name, std::string value_raw, BlamGlobalType type)
	Registers a new engine global. More...
BLAM_EXT_API void	Blam::API::v1::Globals::RegisterGlobal (std::string name, std::string value_raw, BlamGlobalType type, std::string info)
	Registers a new engine global. More...
BLAM_EXT_API BlamEngineGlobal *	Blam::API::v1::Globals::GetGlobal (std::string name)
	Retrieves a global with the specified ID. More...
BLAM_EXT_API BlamGlobalUpdateResult	Blam::API::v1::Globals::UpdateGlobal (std::string name, std::string new_value)
	Updates the value of a String global. More...
BLAM_EXT_API BlamGlobalUpdateResult	Blam::API::v1::Globals::UpdateGlobal (std::string name, bool new_value)
	Updates the value of a Boolean global. More...
BLAM_EXT_API BlamGlobalUpdateResult	Blam::API::v1::Globals::UpdateGlobal (std::string name, int new_value)
	Updates the value of a Integer global. More...
BLAM_EXT_API BlamGlobalUpdateResult	Blam::API::v1::Globals::UpdateGlobal (std::string name, short new_value)
	Updates the value of a Short global. More...
BLAM_EXT_API BlamGlobalUpdateResult	Blam::API::v1::Globals::UpdateGlobal (std::string name, long new_value)
	Updates the value of a Long global. More...
BLAM_EXT_API BlamGlobalUpdateResult	Blam::API::v1::Globals::UpdateGlobal (std::string name, float new_value)
	Updates the value of a Float global. More...
BLAM_EXT_API BlamGlobalUpdateResult	Blam::API::v1::Globals::UpdateGlobal (std::string name, BlamColor new_value)
	Updates the value of a Color global. More...
BLAM_EXT_API bool *	Blam::API::v1::Globals::GetGlobalAsBoolean (std::string name)
	Retrieves a global's value as a boolean. More...
BLAM_EXT_API std::string *	Blam::API::v1::Globals::GetGlobalAsString (std::string name)
	Retrieves a global's value as a string. More...
BLAM_EXT_API short *	Blam::API::v1::Globals::GetGlobalAsShort (std::string name)
	Retrieves a global's value as a short. More...
BLAM_EXT_API long *	Blam::API::v1::Globals::GetGlobalAsLong (std::string name)
	Retrieves a global's value as a long. More...
BLAM_EXT_API int *	Blam::API::v1::Globals::GetGlobalAsInteger (std::string name)
	Retrieves a global's value as an int. More...
BLAM_EXT_API float *	Blam::API::v1::Globals::GetGlobalAsFloat (std::string name)
	Retrieves a global's value as a float. More...
BLAM_EXT_API BlamColor *	Blam::API::v1::Globals::GetGlobalAsColor (std::string name)
	Retrieves a global's value as a BlamColor. More...
BLAM_EXT_API void	Blam::API::v1::Logger::LogEvent (std::string message)
	Writes a message to the game engine log. More...
BLAM_EXT_API void	Blam::API::v1::Tags::LoadScenarioTag (std::string path)
	Attempts to load a scenario tag from a given tag path. More...
BLAM_EXT_API BlamTagClass *	Blam::API::v1::Tags::GetTagClass (std::string class_name)
	Retrieves a tag class from either its short or long class name. More...
BLAM_EXT_API BlamResult	Blam::API::v1::Tags::LoadTagFromMemory (char *address, int size, const char *tag_path)
	Loads a tag from a block of memory. More...
BLAM_EXT_API BlamTagData *	Blam::API::v1::Tags::GetTagData (std::string tag_path)
	Retrieves information for a given tag. More...
BLAM_EXT_API void	Blam::API::v1::Tags::RegisterTagClass (BlamTagClass *data)
	Registers a new tag class within the engine. More...
BLAM_EXT_API BlamWorldState *	Blam::API::v1::World::GetWorldState ()
	Retrieves the current world state. More...
BLAM_EXT_API std::vector< BlamWorldObject * >	Blam::API::v1::World::Raycast ()
void	Blam::API::v1::HS::Abort (std::string confirm="")
void	Blam::API::v1::HS::Classify (std::string command)
void	Blam::API::v1::HS::Cls ()
void	Blam::API::v1::HS::Crash (std::string confirm)
void	Blam::API::v1::HS::CreateCmdObj ()
void	Blam::API::v1::HS::DebugMenuRebuild ()
void	Blam::API::v1::HS::Drop (std::string tag_name)
void	Blam::API::v1::HS::DxRenderTargetClear (bool enable)
void	Blam::API::v1::HS::Explore (std::string mode, std::string path)
void	Blam::API::v1::HS::GeneratePlugins ()
void	Blam::API::v1::HS::H2Help (std::string command)
void	Blam::API::v1::HS::H2Print (std::string message)
void	Blam::API::v1::HS::Help ()
void	Blam::API::v1::HS::History ()
void	Blam::API::v1::HS::ListColors ()
void	Blam::API::v1::HS::ListLevels ()
void	Blam::API::v1::HS::ListenerBugCheck ()
void	Blam::API::v1::HS::MapName (std::string scenario_name)
void	Blam::API::v1::HS::NoU ()
void	Blam::API::v1::HS::OpenGameDir ()
void	Blam::API::v1::HS::OpenWebURL (std::string url)
void	Blam::API::v1::HS::Print (std::string message)
void	Blam::API::v1::HS::Quit ()
void	Blam::API::v1::HS::ReloadMaterialDatablocks ()
void	Blam::API::v1::HS::ScreenRes (std::string resolution)
void	Blam::API::v1::HS::Screenshot (std::string filename="")
void	Blam::API::v1::HS::ScriptDoc (bool quiet=false)
void	Blam::API::v1::HS::SentryTest ()
void	Blam::API::v1::HS::ShowStats ()
void	Blam::API::v1::HS::TagFieldSizes ()
void	Blam::API::v1::HS::TagLoadForce (std::string tag_path)
void	Blam::API::v1::HS::ToggleImguiWindow (std::string window_name)
void	Blam::API::v1::HS::Version ()
void	Blam::API::v1::HS::Win32DialogTest ()
BLAM_EXT_API bool	Blam::API::v1::Hooking::GetEngineHookState ()
	Retrieves the engine's hook state. More...
BLAM_EXT_API void	Blam::API::v1::Hooking::SetEngineHookState (bool hook_state)
	Sets whether or not the engine is hooked via Qt. More...
BLAM_EXT_API bool	Blam::API::v1::Hooking::MainWindowProcedure (SDL_Event event)
	Window Procedure for the main application window. More...
BLAM_EXT_API int	Blam::API::v1::Hooking::StartEngine (int args_count, char *args[], SDL_Window *window)
	Entry point for the engine. More...
BLAM_EXT_API void	Blam::API::v1::Hooking::MainLoop ()
	Function for the engine's main loop. More...
BLAM_EXT_API int	Blam::API::v1::Hooking::EngineThreadInit ()
	Performs any additional engine initialization that needs to be called within the engine loop thread. More...
BLAM_EXT_API void	Blam::API::v1::Hooking::CleanupEngineResources ()
	Instructs the engine to clean up any resources. More...
BLAM_EXT_API void	Blam::API::v1::ExecuteConsoleCommand (const char *command)
	Runs a command through the engine's console. More...
BLAM_EXT_API void	Blam::API::v1::ResizeViewport (int width, int height)
	Resizes the engine's viewport resolution. More...
BLAM_EXT_API BlamVector3	Blam::API::v1::GetDirectorPosition ()
	Retrieves the current position of the debug director. More...
BLAM_EXT_API float	Blam::API::v1::GetDirectorSpeed ()
	Retrieves the current speed of the debug director. More...
BLAM_EXT_API BlamVector2	Blam::API::v1::GetMousePosition2D ()
	Retrieves the 2D position of the mouse pointer. More...
BLAM_EXT_API BlamVector3	Blam::API::v1::GetMousePosition3D ()
	Retrieves the 3D position of the mouse pointer. More...
BLAM_EXT_API void	Blam::API::v1::SetEngineViewportActive (bool viewport_active)
	API wrapper around ImGui_ImplSDL2_SetActiveWindowOverride. More...
BLAM_EXT_API bool	Blam::API::v1::IsMouseCapturedByDirector ()
	Checks if the mouse is currently captured by the debug director. More...
BLAM_EXT_API BlamVector2	Blam::API::v1::GetGameResolution ()
	Retrieves the current render resolution for the engine. More...

Macro Definition Documentation

BLAM_EXT_API

#define BLAM_EXT_API   __declspec(dllimport)