ModSpec Struct Reference

#include <mods.h>

Collaboration diagram for ModSpec:

Public Member Functions
	ModSpec ()
	ModSpec (const std::string &name, const std::string &path, int modpack_depth, const std::string &virtual_path)
void	checkAndLog () const

Public Attributes
bool	is_name_explicit = false
std::string	name
std::string	author
std::string	path
std::string	desc
int	release = 0
std::unordered_set< std::string >	depends
std::unordered_set< std::string >	optdepends
std::unordered_set< std::string >	unsatisfied_depends
int	modpack_depth = 0
bool	is_modpack = false
std::string	virtual_path
	A constructed canonical path to represent this mod's location.
std::vector< const char * >	deprecation_msgs
std::map< std::string, ModSpec >	modpack_content

Constructor & Destructor Documentation

ModSpec() [1/2]

ModSpec::ModSpec ( )

inline

ModSpec() [2/2]

ModSpec::ModSpec ( const std::string & name, const std::string & path, int modpack_depth, const std::string & virtual_path )

inline

Member Function Documentation

checkAndLog()

void ModSpec::checkAndLog

(

)

const

References deprecation_msgs, Error, get_deprecated_handling_mode(), Ignore, MODNAME_ALLOWED_CHARS, name, path, string_allowed(), and warningstream.

Here is the call graph for this function:

Member Data Documentation

author

std::string ModSpec::author

Referenced by parseModContents(), and push_mod_spec().

depends

std::unordered_set<std::string> ModSpec::depends

Referenced by ModApiMainMenu::l_get_content_info(), and parseModContents().

deprecation_msgs

std::vector<const char *> ModSpec::deprecation_msgs

Referenced by checkAndLog(), and parseModContents().

desc

std::string ModSpec::desc

Referenced by parseModContents(), and push_mod_spec().

is_modpack

bool ModSpec::is_modpack = false

Referenced by flattenMods(), and parseModContents().

is_name_explicit

bool ModSpec::is_name_explicit = false

Referenced by parseModContents().

modpack_content

std::map<std::string, ModSpec> ModSpec::modpack_content

Referenced by flattenMods(), and parseModContents().

modpack_depth

int ModSpec::modpack_depth = 0

Referenced by parseModContents().

name

std::string ModSpec::name

Referenced by checkAndLog(), ModApiMainMenu::l_check_mod_configuration(), parseModContents(), push_mod_spec(), and ModConfiguration::resolveDependencies().

optdepends

std::unordered_set<std::string> ModSpec::optdepends

Referenced by ModApiMainMenu::l_get_content_info(), and parseModContents().

path

std::string ModSpec::path

Referenced by ModConfiguration::addMods(), checkAndLog(), ScriptApiSecurity::checkPathWithGamedef(), ModApiBase::getCurrentModPath(), ServerModManager::getModsMediaPaths(), ModApiMainMenu::l_check_mod_configuration(), ModApiMainMenu::l_get_content_info(), ModApiServer::l_get_modpath(), parseModContents(), and push_mod_spec().

release

int ModSpec::release = 0

Referenced by parseModContents(), and push_mod_spec().

unsatisfied_depends

std::unordered_set<std::string> ModSpec::unsatisfied_depends

Referenced by push_mod_spec(), and ModConfiguration::resolveDependencies().

virtual_path

std::string ModSpec::virtual_path

A constructed canonical path to represent this mod's location.

This intended to be used as an identifier for a modpath that tolerates file movement, and cannot be used to read the mod files.

Note that mymod is the directory name, not the mod name specified in mod.conf.

Ex:

• mods/mymod
• mods/mymod (1) (^ this would have name=mymod in mod.conf)
• mods/modpack1/mymod
• games/mygame/mods/mymod
• worldmods/mymod

Referenced by ModApiMainMenu::l_check_mod_configuration(), parseModContents(), and push_mod_spec().

---

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

• content/mods.h
• content/mods.cpp