sf_error_registry.h File Reference

#include "../../api/sfsf.h"
#include "../core/sf_wrappers.h"
#include <list>

Include dependency graph for sf_error_registry.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	RegisteredMod
	A mod as shown in the in-game mod list. More...

Enumerations
enum	ConflictDomain {   CONFLICT_SPELL_ID = 0 , CONFLICT_SPELL_EFFECT_ID , CONFLICT_BUILDING_ID , CONFLICT_CAMPAIGN_FOLDER ,   CONFLICT_CAMPAIGN_NAME , CONFLICT_CAMPAIGN_AVATAR_TYPE , CONFLICT_DOMAIN_COUNT }
	Namespaces for conflict checking. More...
enum	ModType { MOD_TYPE_FRAMEWORK = 0 , MOD_TYPE_CORE , MOD_TYPE_EXTERNAL }
	What sort of mod an entry in the mod list is. More...

Functions
const char *	get_mod_type_label (ModType type)
	Tag rendered next to a mod in the list. Empty for external mods.
void	append_mod_error (SFMod *mod, const char *format,...)
	Appends a line to a mod's error buffer without logging it.
void	report_mod_error (SFMod *mod, const char *format,...)
	Logs an error, appends it to the mod's error buffer and counts it.
void	report_mod_warning (SFMod *mod, const char *format,...)
	Logs a warning against a mod at DEBUG_INFO, i.e. always shown.
void	report_mod_warning (SFMod *mod, DebugLevel level, const char *format,...)
	Logs a warning against a mod, shown only at level or more verbose.
void	clear_mod_errors (SFMod *mod)
	Empties a mod's error buffer.
bool	claim_numeric_id (ConflictDomain domain, uint32_t id, SFMod *mod, uint32_t vanilla_max, const char *id_label)
	Claims a numeric ID within a domain for a mod.
bool	claim_string_id (ConflictDomain domain, const char *key, SFMod *mod, const char *id_label)
	Claims a string key within a domain for a mod. Comparison is case-insensitive, since the keys are Windows paths and menu labels.
void	reset_conflict_domain (ConflictDomain domain)
	Drops every claim in a domain. Intended for reloads and tests.
void	register_mod_for_listing (SFMod *mod, ModType type)
	Adds a mod to the list rendered by the in-game mod list screen.
const std::list< RegisteredMod > &	get_registered_mods ()
	The mods known to the framework, grouped framework -> core -> external.