PluginFileHandler Class Reference

Private Member Functions
void	PluginConfigHandler ()
override void	OnInit ()
override string	GetFileName ()
void	LoadConfigFile ()
void	SaveConfigToFile ()
CfgParam	GetParamByName (string name, int cfg_type)
array< ref CfgParam >	GetAllParams ()
void	ClearParams ()
void	RemoveParamByName (string name)
void	RenameParam (string name, string new_name)
bool	ParamExist (string name)
string	ParseParam (CfgParam param)
CfgParam	ParseText (string text)
protected int	GetTextType (string text)
protected bool	IsString (string text)
protected bool	IsParam (string text)
protected bool	IsArray (string text)
protected bool	IsFloat (string text)
protected bool	IsInt (string text)
protected bool	IsBool (string text)
protected string	ParseToValueString (string param_value)
protected float	ParseToValueFloat (string param_value)
protected int	ParseToValueInt (string param_value)
protected bool	ParseToValueBool (string param_value)
protected array< ref CfgParam >	ParseToValueArray (string param_value)
void	PluginLocalHistoryBase ()
void	~PluginLocalHistoryBase ()
override void	OnInit ()
override string	GetFileName ()
void	AddNewLine (string text)
TStringArray	GetAllLines ()
TStringArray	GetLastLine ()
void	PluginLocalProfile ()
override string	GetFileName ()
override void	OnInit ()
bool	LoadConfigFile ()
void	SaveConfigToFile ()
bool	IsTextArray (string text)
TStringArray	ParseTextToParameter (string text)
TStringArray	ParseTextToArray (string text, out TStringArray ret)
array< ref map< string, string > >	ParseTextArrayToParameters (string text)
string	LoadParameter (string param_name)
TStringArray	LoadParameterArray (string param_name)
string	LoadSubParameter (string param_name, int sub_array_index, string sub_param_name)
void	SaveParameter (string param_name, string value, bool save_in_file=true)
void	SaveParameterArray (string param_name, TStringArray value, bool save_in_file=true)
void	SaveSubParameterInArray (string param_name, int sub_array_index, string sub_param_name, string sub_param_value, bool save_in_file=true)
void	RenameParameter (string old_name, string new_name, bool save_in_file=true)
void	RenameParameterArray (string old_name, string new_name, bool save_in_file=true)
void	RemoveParameter (string name, bool save_in_file=true)
void	RemoveParameterArray (string name, bool save_in_file=true)
void	SetParameterString (string name, string value, bool save_in_file=true)
void	SetParameterInt (string name, int value, bool save_in_file=true)
void	SetParameterFloat (string name, float value, bool save_in_file=true)
void	SetParameterBool (string name, bool value, bool save_in_file=true)
void	SetParameterArray (string name, TStringArray value, bool save_in_file=true)
void	SetSubParameterInArray (string param_name, int sub_array_index, string sub_param_name, string sub_param_value, bool save_in_file=true)
string	GetParameterString (string name)
int	GetParameterInt (string name)
float	GetParameterFloat (string name)
bool	GetParameterBool (string name)
TStringArray	GetParameterArray (string name)
string	GetSubParameterInArrayString (string param_name, int sub_array_index, string sub_param_name)
TStringArray	GetAllSubParametersInArrayString (string param_name, string sub_param_name)

Private Attributes
ref array< ref CfgParam >	m_CfgParams
ref map< string, string >	m_ConfigParams
ref map< string, ref TStringArray >	m_ConfigParamsArray
ref map< string, ref map< string, string > >	m_ConfigParamsInArray
ref map< string, ref array< ref map< string, string > > >	m_ConfigParamsArrayInArray

Constructor & Destructor Documentation

~PluginLocalHistoryBase()

void ~PluginLocalHistoryBase ( )

inlineprivate

Member Function Documentation

AddNewLine()

void AddNewLine ( string  text )

inlineprivate

References string::Replace().

ClearParams()

void ClearParams ( )

inlineprivate

GetAllLines()

TStringArray GetAllLines ( )

inlineprivate

References string::Replace().

GetAllParams()

array< ref CfgParam > GetAllParams ( )

inlineprivate

GetAllSubParametersInArrayString()

TStringArray GetAllSubParametersInArrayString ( string  param_name, string  sub_param_name  )

inlineprivate

References string::Get(), and STRING_EMPTY.

GetFileName() [1/3]

override string GetFileName ( )

inlineprivate

References CFG_FILE_USER_PROFILE.

Referenced by PluginBase::LoadFile(), and PluginBase::SaveFile().

GetFileName() [2/3]

override string GetFileName ( )

inlineprivate

References Error(), and STRING_EMPTY.

GetFileName() [3/3]

override string GetFileName ( )

inlineprivate

References CFG_FILE_USER_PROFILE.

GetLastLine()

TStringArray GetLastLine ( )

inlineprivate

References string::Get().

GetParamByName()

CfgParam GetParamByName ( string  name, int  cfg_type  )

inlineprivate

References CfgParam::CreateParam(), CfgParam::GetName(), and name.

GetParameterArray()

TStringArray GetParameterArray ( string  name )

inlineprivate

References name.

GetParameterBool()

bool GetParameterBool ( string  name )

inlineprivate

References name, and string::ToInt().

GetParameterFloat()

float GetParameterFloat ( string  name )

inlineprivate

References name, and string::ToFloat().

GetParameterInt()

int GetParameterInt ( string  name )

inlineprivate

References name, and string::ToInt().

GetParameterString()

string GetParameterString ( string  name )

inlineprivate

References name, string::Split(), and STRING_EMPTY.

GetSubParameterInArrayString()

string GetSubParameterInArrayString ( string  param_name, int  sub_array_index, string  sub_param_name  )

inlineprivate

References string::Split(), and STRING_EMPTY.

GetTextType()

protected int GetTextType ( string  text )

inlineprivate

References CFG_TYPE_ARRAY, CFG_TYPE_BOOL, CFG_TYPE_FLOAT, CFG_TYPE_INT, CFG_TYPE_PARAM, CFG_TYPE_STRING, string::IndexOf(), string::Length(), and string::Substring().

IsArray()

protected bool IsArray ( string  text )

inlineprivate

References CFG_TYPE_ARRAY.

IsBool()

protected bool IsBool ( string  text )

inlineprivate

References CFG_TYPE_BOOL.

IsFloat()

protected bool IsFloat ( string  text )

inlineprivate

References CFG_TYPE_FLOAT.

IsInt()

protected bool IsInt ( string  text )

inlineprivate

References CFG_TYPE_INT.

IsParam()

protected bool IsParam ( string  text )

inlineprivate

References CFG_TYPE_PARAM.

IsString()

protected bool IsString ( string  text )

inlineprivate

References CFG_TYPE_STRING.

IsTextArray()

bool IsTextArray ( string  text )

inlineprivate

References string::Length(), and string::Substring().

LoadConfigFile() [1/2]

void LoadConfigFile ( )

inlineprivate

LoadConfigFile() [2/2]

bool LoadConfigFile ( )

inlineprivate

References PluginLocalProfile::GetFileName(), PrintString(), and string::ToString().

LoadParameter()

string LoadParameter ( string  param_name )

inlineprivate

References string::Get(), and STRING_EMPTY.

LoadParameterArray()

TStringArray LoadParameterArray ( string  param_name )

inlineprivate

LoadSubParameter()

string LoadSubParameter ( string  param_name, int  sub_array_index, string  sub_param_name  )

inlineprivate

References string::Get(), and STRING_EMPTY.

OnInit() [1/3]

override void OnInit ( )

inlineprivate

OnInit() [2/3]

override void OnInit ( )

inlineprivate

OnInit() [3/3]

override void OnInit ( )

inlineprivate

ParamExist()

bool ParamExist ( string  name )

inlineprivate

References CfgParam::GetName(), and name.

ParseParam()

string ParseParam ( CfgParam  param )

inlineprivate

References CFG_TYPE_ARRAY, CFG_TYPE_BOOL, CFG_TYPE_FLOAT, CFG_TYPE_INT, CFG_TYPE_STRING, CfgParam::GetName(), CfgParam::GetType(), string::IndexOf(), STRING_EMPTY, and string::ToString().

ParseText()

CfgParam ParseText ( string  text )

inlineprivate

References CFG_TYPE_ARRAY, CFG_TYPE_BOOL, CFG_TYPE_FLOAT, CFG_TYPE_INT, CFG_TYPE_PARAM, CFG_TYPE_STRING, string::IndexOf(), string::Length(), CfgParam::SetName(), STRING_EMPTY, string::Substring(), and string::Trim().

ParseTextArrayToParameters()

array< ref map< string, string > > ParseTextArrayToParameters ( string  text )

inlineprivate

ParseTextToArray()

TStringArray ParseTextToArray ( string  text, out TStringArray  ret  )

inlineprivate

References string::IndexOf(), string::IndexOfFrom(), string::Insert(), string::Length(), string::Split(), and string::Substring().

ParseTextToParameter()

TStringArray ParseTextToParameter ( string  text )

inlineprivate

References string::IndexOf(), string::Length(), string::Substring(), and string::Trim().

ParseToValueArray()

protected array< ref CfgParam > ParseToValueArray ( string  param_value )

inlineprivate

References string::IndexOfFrom(), string::Length(), string::Split(), and string::Substring().

ParseToValueBool()

protected bool ParseToValueBool ( string  param_value )

inlineprivate

References string::Contains().

ParseToValueFloat()

protected float ParseToValueFloat ( string  param_value )

inlineprivate

References string::ToFloat().

ParseToValueInt()

protected int ParseToValueInt ( string  param_value )

inlineprivate

References string::ToInt().

ParseToValueString()

protected string ParseToValueString ( string  param_value )

inlineprivate

References string::Length(), and string::Substring().

PluginConfigHandler()

void PluginConfigHandler ( )

inlineprivate

PluginLocalHistoryBase()

void PluginLocalHistoryBase ( )

inlineprivate

PluginLocalProfile()

void PluginLocalProfile ( )

inlineprivate

RemoveParamByName()

void RemoveParamByName ( string  name )

inlineprivate

References CfgParam::GetName(), and name.

RemoveParameter()

void RemoveParameter ( string  name, bool  save_in_file = true  )

inlineprivate

References name.

RemoveParameterArray()

void RemoveParameterArray ( string  name, bool  save_in_file = true  )

inlineprivate

References name.

RenameParam()

void RenameParam ( string  name, string  new_name  )

inlineprivate

References CfgParam::GetName(), name, and CfgParam::SetName().

RenameParameter()

void RenameParameter ( string  old_name, string  new_name, bool  save_in_file = true  )

inlineprivate

RenameParameterArray()

void RenameParameterArray ( string  old_name, string  new_name, bool  save_in_file = true  )

inlineprivate

SaveConfigToFile() [1/2]

void SaveConfigToFile ( )

inlineprivate

SaveConfigToFile() [2/2]

void SaveConfigToFile ( )

inlineprivate

SaveParameter()

void SaveParameter ( string  param_name, string  value, bool  save_in_file = true  )

inlineprivate

References Log().

SaveParameterArray()

void SaveParameterArray ( string  param_name, TStringArray  value, bool  save_in_file = true  )

inlineprivate

SaveSubParameterInArray()

void SaveSubParameterInArray ( string  param_name, int  sub_array_index, string  sub_param_name, string  sub_param_value, bool  save_in_file = true  )

inlineprivate

SetParameterArray()

void SetParameterArray ( string  name, TStringArray  value, bool  save_in_file = true  )

inlineprivate

References name.

SetParameterBool()

void SetParameterBool ( string  name, bool  value, bool  save_in_file = true  )

inlineprivate

References name, and bool::ToString().

SetParameterFloat()

void SetParameterFloat ( string  name, float  value, bool  save_in_file = true  )

inlineprivate

References name, and float::ToString().

SetParameterInt()

void SetParameterInt ( string  name, int  value, bool  save_in_file = true  )

inlineprivate

References name.

SetParameterString()

void SetParameterString ( string  name, string  value, bool  save_in_file = true  )

inlineprivate

References name.

SetSubParameterInArray()

void SetSubParameterInArray ( string  param_name, int  sub_array_index, string  sub_param_name, string  sub_param_value, bool  save_in_file = true  )

inlineprivate

Field Documentation

m_CfgParams

ref array<ref CfgParam> m_CfgParams

private

m_ConfigParams

ref map<string, string> m_ConfigParams

private

m_ConfigParamsArray

ref map<string, ref TStringArray> m_ConfigParamsArray

private

m_ConfigParamsArrayInArray

ref map<string, ref array<ref map<string, string> > > m_ConfigParamsArrayInArray

private

m_ConfigParamsInArray

ref map<string, ref map<string, string> > m_ConfigParamsInArray

private

---

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

• P:/scripts/4_World/Plugins/PluginBase/PluginFileHandler/PluginConfigHandler.c
• P:/scripts/4_World/Plugins/PluginBase/PluginFileHandler/PluginLocalProfile.c
• P:/scripts/4_World/Plugins/PluginBase/PluginFileHandler/PluginLocalHistoryBase.c