globals.h File Reference

#include <string>
#include <map>
#include <vector>
#include <Strings/components/resources/color/BlamColor.h>
#include <Strings/components/utils/string/string.h>

Go to the source code of this file.

Classes
struct	Blam::Globals::EngineGlobal
	Structure containing data for a game engine global. More...

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::Globals
	Namespace containing things relating to game engine globals.

Macros
#define	GVARS_FILE   "./globals.xml"
	The file to read globals from. More...
#define	BLAM

Enumerations
enum	Blam::Globals::GvarUpdateResult {   Blam::Globals::InvalidType, Blam::Globals::UnknownGlobal, Blam::Globals::Ok, Blam::Globals::InvalidArgs,   Blam::Globals::OutOfBounds, Blam::Globals::GlobalIsProtected }
	Enumerator for the result of a global update attempt. More...
enum	Blam::Globals::GvarType {   Blam::Globals::Boolean, Blam::Globals::Real, Blam::Globals::Short, Blam::Globals::Long,   Blam::Globals::Object, Blam::Globals::String, Blam::Globals::Int, Blam::Globals::Float,   Blam::Globals::Color }
	Enumerator for the type of global variable. More...

Functions
BLAM std::map< std::string, EngineGlobal > *	Blam::Globals::GetGlobalsList ()
	Retrieves the list of loaded globals. More...
BLAM bool	Blam::Globals::LoadGlobalsFromFile ()
	Loads any globals from GVARS_FILE. More...
BLAM std::string	Blam::Globals::GetGvarTypeLabel (GvarType type)
	Retrieves a string representation of a global's type, for use in UI. More...
BLAM bool	Blam::Globals::GlobalExists (std::string id)
	Determines whether or not a global exists. More...
BLAM void	Blam::Globals::RegisterGvar (EngineGlobal var)
	Registers a new engine global. More...
BLAM void	Blam::Globals::RegisterGvar (std::string name, std::string value_raw, GvarType type)
	Registers a new engine global. More...
BLAM void	Blam::Globals::RegisterGvar (std::string name, std::string value_raw, GvarType type, std::string info)
	Registers a new engine global. More...
BLAM EngineGlobal *	Blam::Globals::GetGlobal (std::string name)
	Retrieves a global with the specified ID. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobalWrap (std::string name, std::string new_value)
	Updates a global's raw value. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobal (std::string name, std::string new_value)
	Updates the value of a String global. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobal (std::string name, bool new_value)
	Updates the value of a Boolean global. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobal (std::string name, int new_value)
	Updates the value of a Integer global. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobal (std::string name, short new_value)
	Updates the value of a Short global. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobal (std::string name, long new_value)
	Updates the value of a Long global. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobal (std::string name, float new_value)
	Updates the value of a Float global. More...
BLAM GvarUpdateResult	Blam::Globals::UpdateGlobal (std::string name, BlamColor new_value)
	Updates the value of a Color global. More...
BLAM bool *	Blam::Globals::GetGlobalAsBoolean (std::string name)
	Retrieves a global's value as a boolean. More...
BLAM std::string *	Blam::Globals::GetGlobalAsString (std::string name)
	Retrieves a global's value as a string. More...
BLAM short *	Blam::Globals::GetGlobalAsShort (std::string name)
	Retrieves a global's value as a short. More...
BLAM long *	Blam::Globals::GetGlobalAsLong (std::string name)
	Retrieves a global's value as a long. More...
BLAM int *	Blam::Globals::GetGlobalAsInteger (std::string name)
	Retrieves a global's value as an int. More...
BLAM float *	Blam::Globals::GetGlobalAsFloat (std::string name)
	Retrieves a global's value as a float. More...
BLAM BlamColor *	Blam::Globals::GetGlobalAsColor (std::string name)
	Retrieves a global's value as a BlamColor. More...

Macro Definition Documentation

BLAM

#define BLAM

GVARS_FILE

#define GVARS_FILE   "./globals.xml"

The file to read globals from.