engine_definitions.h

Go to the documentation of this file.

#pragma once
 
#include <string>
 
#ifdef _NDEBUG
#define REL_TYPE "release"
#else
#define REL_TYPE "debug"
#endif
// The Halo 2 Alpha revealed that REL_TYPE can also be alpha, beta, or other such things.
 
#define DEV_MODE true
 
// BLAMITE VERSIONING GUIDELINES   //
// XXXXX.MM.DD.YY.ZZZZ.NNNNNNNNNNN //
 
/*
╔═════════════════════════════════╗
║  BLAMITE VERSIONING GUIDELINES  ║
╠═════════════════════════════════╣
║ XXXXX                           ║
╟─────────────────────────────────╢
║ This should be replaced with   ║
║ the build major version.       ║
╠═════════════════════════════════╣
║ MM.DD.YY                       ║
╟─────────────────────────────────╢
║ This refers to the date that   ║
║ the build was created:         ║
║ Month.Day.Year format.         ║
╠═════════════════════════════════╣
║ ZZZZ                           ║
╟─────────────────────────────────╢
║ This should be replaced with       ║
║ the build minor number.        ║
╠═════════════════════════════════╣
║ NNNNNNNNNNN                    ║
╟─────────────────────────────────╢
║ This should be replaced with       ║
║ the build's actual name.       ║
╚═════════════════════════════════╝
*/
 
/* box drawing characters
 
─  ━  │  ┃  ┄  ┅  ┆  ┇  ┈  ┉  ┊  ┋  ┌  ┍  ┎  ┏
┐  ┑  ┒  ┓  └  ┕  ┖  ┗  ┘  ┙  ┚  ┛  ├  ┝  ┞  ┟
┠  ┡  ┢  ┣  ┤  ┥  ┦  ┧  ┨  ┩  ┪  ┫  ┬  ┭  ┮  ┯
┰  ┱  ┲  ┳  ┴  ┵  ┶  ┷  ┸  ┹  ┺  ┻  ┼  ┽  ┾  ┿
╀  ╁  ╂  ╃  ╄  ╅  ╆  ╇  ╈  ╉  ╊  ╋  ╌  ╍  ╎  ╏
═  ║  ╒  ╓  ╔  ╕  ╖  ╗  ╘  ╙  ╚  ╛  ╜  ╝  ╞  ╟
╠  ╡  ╢  ╣  ╤  ╥  ╦  ╧  ╨  ╩  ╪  ╫  ╬  ╭  ╮  ╯
╰  ╱  ╲  ╳  ╴  ╵  ╶  ╷  ╸  ╹  ╺  ╻  ╼  ╽  ╾  ╿
 
*/
 
 
 
#ifndef BLAM
#define BLAM
#endif
 
#ifndef UI_API
#define UI_API
#endif
 
enum class BlamRuntimeConfiguration
{
    CacheRelease,
 
    CacheDebug,
 
    TagDebug,
 
    CacheTest,
 
    TagTest,
 
    Unspecified
};
 
enum class BlamContentSource
{
    Tags, 
    Cache 
};
 
enum class BlamBuildType
{
    Debug,
 
    Test,
 
    Release
};
 
enum class BlamVersionStringDisplayMode
{
    Default,    
    Console,    
    TextLog,    
    CrashScreen 
};
 
namespace Blam::BuildInfo
{
    BLAM BlamRuntimeConfiguration GetCurrentRuntimeConfig();
 
    BLAM BlamContentSource GetContentSource();
 
    BLAM BlamBuildType GetBuildType();
 
    BLAM std::string GetVersionBuildString(BlamVersionStringDisplayMode display_mode);
 
    BLAM std::string GetBuildDateTime();
 
    BLAM std::string GetReleaseType();
}