Structure representing a Blam Project Information file. More...

#include <project_info.h>

Public Member Functions
	PROJECT_SECTION (game_info, { std::string title="core";std::string codename="core";std::string publisher="Elaztek Studios";std::string developer="Elaztek Studios";std::string affiliates="";std::string copyright="Copyright (c) Elaztek Studios 2013-2023";std::string website="https://elaztek.com/";std::string version="";std::string icon="";})

	PROJECT_SECTION (cpp_script_info, { bool uses_cpp_script=false;std::string vcxproj_path="";std::string engine_dependencies_path="";std::string msbuild_path="msbuild.exe";std::string msbuild_extra_args="";std::string pre_build_commands="";std::string post_build_commands="";})

	PROJECT_SECTION (engine_settings, { std::string user_data_folder="/";std::string default_cache="mainmenu";std::string campaign_info="";std::string startup_movie="";std::string content_root="";std::string tags_dir="tags";std::string movies_dir="bink";std::string data_dir="data";std::string cache_dir="maps";std::string plugins_dir="plugins";std::string fonts_dir="maps/fonts";bool allow_user_tag_overrides=false;})

std::string	GetVcxprojPath ()

Public Attributes
bool	load_result = false

std::string	file_path = ""

int	format_version = 0

std::string	project_name = "unnamed"
	The name of the project. More...

std::string	project_root = ""
	The root folder for the project. More...

Detailed Description

Structure representing a Blam Project Information file.

A Blam Project Information file is the main project file used for various purposes within both the Engine and Editing Kit.

Its primary purpose is to store basic information about a game, such as the game title, developer, copyright, version, and several other bits of information.

Additionally, it stores a few settings that are used by the engine for things like networking and startup. It stores the default cache file, default startup movie, and several URLs for online functionality.

Member Function Documentation

◆ GetVcxprojPath()

std::string BlamProjectInfo::GetVcxprojPath ( )

inline

◆ PROJECT_SECTION() [1/3]

BlamProjectInfo::PROJECT_SECTION	(	cpp_script_info	,
		{ bool uses_cpp_script=false;std::string vcxproj_path="";std::string engine_dependencies_path="";std::string msbuild_path="msbuild.exe";std::string msbuild_extra_args="";std::string pre_build_commands="";std::string post_build_commands="";}
	)

◆ PROJECT_SECTION() [2/3]

BlamProjectInfo::PROJECT_SECTION	(	engine_settings	,
		{ std::string user_data_folder="/";std::string default_cache="mainmenu";std::string campaign_info="";std::string startup_movie="";std::string content_root="";std::string tags_dir="tags";std::string movies_dir="bink";std::string data_dir="data";std::string cache_dir="maps";std::string plugins_dir="plugins";std::string fonts_dir="maps/fonts";bool allow_user_tag_overrides=false;}
	)

◆ PROJECT_SECTION() [3/3]

BlamProjectInfo::PROJECT_SECTION	(	game_info	,
		{ std::string title="core";std::string codename="core";std::string publisher="Elaztek Studios";std::string developer="Elaztek Studios";std::string affiliates="";std::string copyright="Copyright (c) Elaztek Studios 2013-2023";std::string website="https://elaztek.com/";std::string version="";std::string icon="";}
	)

Member Data Documentation

◆ file_path

std::string BlamProjectInfo::file_path = ""

◆ format_version

int BlamProjectInfo::format_version = 0

◆ load_result

bool BlamProjectInfo::load_result = false

◆ project_name

std::string BlamProjectInfo::project_name = "unnamed"

The name of the project.

◆ project_root

std::string BlamProjectInfo::project_root = ""

The root folder for the project.

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

Strings/components/resources/project_info/project_info.h

Public Member Functions

Public Attributes