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 GVARS_FILE "globals.xml" 
 
#ifndef BLAM
#define BLAM
#endif
 
namespace Blam
{
    namespace Globals
    {
        enum GvarUpdateResult
        {
            InvalidType,       
            UnknownGlobal,     
            Ok,                
            InvalidArgs,       
            OutOfBounds,       
            GlobalIsProtected 
        };
 
        enum GvarType
        {
            Boolean,  
            Real,     
            Short,    
            Long,     
            Object,   
            String,   
            Int,      
            Float,    
            Color     
        };
 
        struct EngineGlobal
        {
            GvarType 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); 
        };
 
        BLAM std::map<std::string, EngineGlobal>* GetGlobalsList();
 
        BLAM bool               LoadGlobalsFromFile();
 
        BLAM std::string        GetGvarTypeLabel(GvarType type);
 
        BLAM bool               GlobalExists(std::string id);
 
        BLAM void               RegisterGvar(EngineGlobal var);
 
        BLAM void               RegisterGvar(std::string name, std::string value_raw, GvarType type);
 
        BLAM void               RegisterGvar(std::string name, std::string value_raw, GvarType type, std::string info);
 
        BLAM EngineGlobal* GetGlobal(std::string name);
 
        BLAM GvarUpdateResult   UpdateGlobalWrap(std::string name, std::string new_value);
 
        BLAM GvarUpdateResult   UpdateGlobal(std::string name, std::string new_value);
 
        BLAM GvarUpdateResult   UpdateGlobal(std::string name, bool new_value);
 
        BLAM GvarUpdateResult   UpdateGlobal(std::string name, int new_value);
 
        BLAM GvarUpdateResult   UpdateGlobal(std::string name, short new_value);
 
        BLAM GvarUpdateResult   UpdateGlobal(std::string name, long new_value);
 
        BLAM GvarUpdateResult   UpdateGlobal(std::string name, float new_value);
 
        BLAM GvarUpdateResult   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);
    }
}