Structure containing data for a game engine global. More...

#include <globals.h>

Public Attributes
BlamGlobalType	type
	The type of the global. More...

std::string	name = ""
	The name of the global. More...

std::string	info = ""
	An optional description of the global. More...

std::string	value_raw = ""
	The raw value of the global as a string. More...

bool	read_only = false
	Whether or not the global is protected from modification. More...

bool	boolean_value = false
	The boolean value of the global. More...

short	short_value = 0
	The short value of the global. More...

long	long_value = 0
	The long value of the global. More...

int	int_value = 0
	The int value of the global. More...

float	float_value = 0.0f
	The float value of the global. More...

BlamColor	color_value = BlamColor(0, 0, 0)
	The color value of the global. More...

Detailed Description

Structure containing data for a game engine global.

Note: When using globals in source code, do NOT modify the value fields directly. Use #BlamScript::Globals::UpdateGlobal instead. Since a single struct is used for all globals regardless of type, modifying the fields directly will cause an inconsistent state. value_raw is ALWAYS updated, as it is used in several places for displaying the value as text. The UpdateGlobal() functions handle this all on their own.

Member Data Documentation

◆ boolean_value

bool BlamEngineGlobal::boolean_value = false

The boolean value of the global.

◆ color_value

BlamColor BlamEngineGlobal::color_value = BlamColor(0, 0, 0)

The color value of the global.

◆ float_value

float BlamEngineGlobal::float_value = 0.0f

The float value of the global.

◆ info

std::string BlamEngineGlobal::info = ""

An optional description of the global.

◆ int_value

int BlamEngineGlobal::int_value = 0

The int value of the global.

◆ long_value

long BlamEngineGlobal::long_value = 0

The long value of the global.

◆ name

std::string BlamEngineGlobal::name = ""

The name of the global.

◆ read_only

bool BlamEngineGlobal::read_only = false

Whether or not the global is protected from modification.

◆ short_value

short BlamEngineGlobal::short_value = 0

The short value of the global.

◆ type

BlamGlobalType BlamEngineGlobal::type

The type of the global.

◆ value_raw

std::string BlamEngineGlobal::value_raw = ""

The raw value of the global as a string.

The documentation for this struct was generated from the following file:

blam/api/v1/types/globals.h

Public Attributes