globals.h

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <map>
#include <vector>
 
#include <Strings/components/resources/color/BlamColor.h>
#include <Strings/components/utils/string/string.h>
 
#define GLOBALS_FILE "globals.xml" 
 
#ifndef BLAM
#define BLAM
#endif
 
enum class BlamGlobalUpdateResult
{
    InvalidType,       
    UnknownGlobal,     
    Ok,                
    InvalidArgs,       
    OutOfBounds,       
    GlobalIsProtected  
};
 
enum BlamGlobalType
{
    Boolean,  
    Real,     
    Short,    
    Long,     
    //Object,   //!< Unknown. Referenced within the `hs_doc` from Halo 2 Sapien.
    String,   
    Int,      
    Color     
};
 
struct BlamEngineGlobal
{
    BlamGlobalType type;     
    std::string name = "";   
    std::string info = "";   
    std::string value_raw = "";  
    bool read_only = false;  
 
    // Additional value storage types, these are used in place of value_raw based on type. //
 
    bool boolean_value = false; 
    short short_value = 0;      
    long long_value = 0;        
    int int_value = 0;          
    float float_value = 0.0f;   
    BlamColor color_value = BlamColor(0, 0, 0); 
};
 
namespace Blam::Globals
{
    BLAM std::map<std::string, BlamEngineGlobal>* GetGlobalsList();
 
    BLAM bool LoadGlobalsFromFile();
 
    BLAM std::string GetGlobalTypeLabel(BlamGlobalType type);
 
    BLAM bool GlobalExists(std::string id);
 
    BLAM void RegisterGlobal(BlamEngineGlobal var);
 
    BLAM void RegisterGlobal(std::string name, std::string value_raw, BlamGlobalType type);
 
    BLAM void RegisterGlobal(std::string name, std::string value_raw, BlamGlobalType type, std::string info);
 
    BLAM BlamEngineGlobal* GetGlobal(std::string name);
 
    BLAM BlamGlobalUpdateResult UpdateGlobalWrap(std::string name, std::string new_value);
 
    BLAM BlamGlobalUpdateResult UpdateGlobal(std::string name, std::string new_value);
 
    BLAM BlamGlobalUpdateResult UpdateGlobal(std::string name, bool new_value);
 
    BLAM BlamGlobalUpdateResult UpdateGlobal(std::string name, int new_value);
 
    BLAM BlamGlobalUpdateResult UpdateGlobal(std::string name, short new_value);
 
    BLAM BlamGlobalUpdateResult UpdateGlobal(std::string name, long new_value);
 
    BLAM BlamGlobalUpdateResult UpdateGlobal(std::string name, float new_value);
 
    BLAM BlamGlobalUpdateResult UpdateGlobal(std::string name, BlamColor new_value);
 
    BLAM bool* GetGlobalAsBoolean(std::string name);
 
    BLAM std::string* GetGlobalAsString(std::string name);
 
    BLAM short* GetGlobalAsShort(std::string name);
 
    BLAM long* GetGlobalAsLong(std::string name);
 
    BLAM int* GetGlobalAsInteger(std::string name);
 
    BLAM float* GetGlobalAsFloat(std::string name);
 
    BLAM BlamColor* GetGlobalAsColor(std::string name);
}