Urho3D::ConfigFile Class Reference

A class responsible for serializing configuration parameters. More...

#include <Urho3D/Engine/ConfigFile.h>

Inheritance diagram for Urho3D::ConfigFile:

Classes
struct	ConfigFlavor

Public Types
using	ConfigFlavorVector = ea::vector< ConfigFlavor >
using	ConfigVariableDefinitionMap = ea::unordered_map< ea::string, ConfigVariableDefinition >

Public Member Functions
	ConfigFile (Context *context)
ConfigVariableDefinition &	DefineVariable (const ea::string &name, const Variant &defaultValue=Variant::EMPTY)
	Define variable supported by the config.
void	DefineVariables (const StringVariantMap &defaults)
	Define new variables or update defaults for existing ones.
void	UpdatePriorityVariables (const StringVariantMap &defaults)
	Update values for priority variables.
void	SetVariable (const ea::string &name, const Variant &value)
	Set variable value.
bool	HasVariable (const ea::string &name) const
	Return whether variable is explicitly defined.
const ConfigVariableDefinition *	GetVariableDefinition (const ea::string &name) const
	Return variable definition (if present).
const Variant &	GetVariable (const ea::string &name) const
	Return variable value or default.
void	SerializeInBlock (Archive &archive) override
	Serialize persistent variable configuration. Current values are not serialized.
bool	LoadDefaults (const ea::string &fileName, const ApplicationFlavor &flavor)
	Load default variables from file.
bool	LoadOverrides (const ea::string &fileName)
	Load variable overrides from file.
bool	SaveOverrides (const ea::string &fileName, const ApplicationFlavor &flavor) const
	Save variable overrides to file.
StringVariantMap	GetFlavorVariables (const ApplicationFlavor &flavor) const
StringVariantMap	GetChangedVariables (const ApplicationFlavor &flavor) const
	Evaluate variables that are changed compared to flavor and global defaults.
ConfigFlavorVector &	GetVariablesPerFlavor ()
const ConfigFlavorVector &	GetVariablesPerFlavor () const
ConfigVariableDefinitionMap &	GetVariableDefinitions ()
const ConfigVariableDefinitionMap &	GetVariableDefinitions () const
StringVariantMap &	GetVariables ()
const StringVariantMap &	GetVariables () const
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T >
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T >
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef ()
int	ReleaseRef ()
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Private Member Functions
	URHO3D_OBJECT (ConfigFile, Object)

Private Attributes
ConfigFlavorVector	variablesPerFlavor_
	Configuration variables per flavor, not used directly.
ConfigVariableDefinitionMap	definitions_
	Definitions of supported variables with metadata and default values.
StringVariantMap	variables_
	Current state of variables.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

A class responsible for serializing configuration parameters.

Member Function Documentation

GetFlavorVariables()

StringVariantMap Urho3D::ConfigFile::GetFlavorVariables

(

const ApplicationFlavor &

flavor

)

const

Evaluate variables which are explicitly configured for specifed flavor. Current values and defaults are ignored.

GetVariablesPerFlavor()

ConfigFlavorVector& Urho3D::ConfigFile::GetVariablesPerFlavor ( )

inline

Return internal data.

---

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

• Urho3D/Engine/ConfigFile.h
• Urho3D/Engine/ConfigFile.cpp