Represents mod metadata. More...

#include <ModInfo.h>

Public Member Functions
	ModInfo (const std::string &path)
	Creates default metadata for a mod at the specified path.

void	load (const std::string &filename)
	Loads the metadata from YAML.

const std::string &	getPath () const
	Gets the path where this mod resides on disk.

const std::string &	getName () const
	Gets the name of this mod.

const std::string &	getDescription () const
	Gets the description for this mod.

const std::string &	getVersion () const
	Gets the version of this mod.

const std::string &	getAuthor () const
	Gets the author of this mod.

const std::string &	getId () const
	Gets the id for this mod.

const std::string &	getMaster () const
	Gets the master this mod can load under. If it can load under any master (or if this mod is a master itself), the return value is empty.

bool	isMaster () const
	Gets whether this mod is a master (i.e. a vanilla game/total conversion)

bool	canActivate (const std::string &curMaster) const
	Gets whether this mod can be activated. More...

int	getReservedSpace () const
	Gets size of mod, bigger mod reserve more values in common colections/surfacesets.

void	setReservedSpace (int reservedSpace)
	Sets mod size (DO NOT use this method outside Options::updateReservedSpace()).

const std::string &	getRequiredExtendedVersion () const
	Gets the OXCE version required by this mod.

const std::vector< std::string > &	getExternalResourceDirs () const
	Gets the list of external resource dirs to load for this mod.

Detailed Description

Represents mod metadata.

Member Function Documentation

bool OpenXcom::ModInfo::canActivate ( const std::string & curMaster ) const

Gets whether this mod can be activated.

Checks if a given mod can be activated.

It must either be:

The documentation for this class was generated from the following files: