Game Framework  2021.05.31
IConfigManager接口 参考

全局配置管理器接口。 更多...

类 IConfigManager 继承关系图:
IDataProvider< IConfigManager >

Public 成员函数

void SetResourceManager (IResourceManager resourceManager)
 设置资源管理器。 更多...
 
void SetDataProviderHelper (IDataProviderHelper< IConfigManager > dataProviderHelper)
 设置全局配置数据提供者辅助器。 更多...
 
void SetConfigHelper (IConfigHelper configHelper)
 设置全局配置辅助器。 更多...
 
void EnsureCachedBytesSize (int ensureSize)
 确保二进制流缓存分配足够大小的内存并缓存。 更多...
 
void FreeCachedBytes ()
 释放缓存的二进制流。 更多...
 
bool HasConfig (string configName)
 检查是否存在指定全局配置项。 更多...
 
bool GetBool (string configName)
 从指定全局配置项中读取布尔值。 更多...
 
bool GetBool (string configName, bool defaultValue)
 从指定全局配置项中读取布尔值。 更多...
 
int GetInt (string configName)
 从指定全局配置项中读取整数值。 更多...
 
int GetInt (string configName, int defaultValue)
 从指定全局配置项中读取整数值。 更多...
 
float GetFloat (string configName)
 从指定全局配置项中读取浮点数值。 更多...
 
float GetFloat (string configName, float defaultValue)
 从指定全局配置项中读取浮点数值。 更多...
 
string GetString (string configName)
 从指定全局配置项中读取字符串值。 更多...
 
string GetString (string configName, string defaultValue)
 从指定全局配置项中读取字符串值。 更多...
 
bool AddConfig (string configName, string configValue)
 增加指定全局配置项。 更多...
 
bool AddConfig (string configName, bool boolValue, int intValue, float floatValue, string stringValue)
 增加指定全局配置项。 更多...
 
bool RemoveConfig (string configName)
 移除指定全局配置项。 更多...
 
void RemoveAllConfigs ()
 清空所有全局配置项。 更多...
 
- Public 成员函数 继承自 IDataProvider< IConfigManager >
void ReadData (string dataAssetName)
 读取数据。 更多...
 
void ReadData (string dataAssetName, int priority)
 读取数据。 更多...
 
void ReadData (string dataAssetName, object userData)
 读取数据。 更多...
 
void ReadData (string dataAssetName, int priority, object userData)
 读取数据。 更多...
 
bool ParseData (string dataString)
 解析内容。 更多...
 
bool ParseData (string dataString, object userData)
 解析内容。 更多...
 
bool ParseData (byte[] dataBytes)
 解析内容。 更多...
 
bool ParseData (byte[] dataBytes, object userData)
 解析内容。 更多...
 
bool ParseData (byte[] dataBytes, int startIndex, int length)
 解析内容。 更多...
 
bool ParseData (byte[] dataBytes, int startIndex, int length, object userData)
 解析内容。 更多...
 

属性

int Count [get]
 获取全局配置项数量。 更多...
 
int CachedBytesSize [get]
 获取缓冲二进制流的大小。 更多...
 

额外继承的成员函数

- 事件 继承自 IDataProvider< IConfigManager >
EventHandler< ReadDataSuccessEventArgsReadDataSuccess
 读取数据成功事件。 更多...
 
EventHandler< ReadDataFailureEventArgsReadDataFailure
 读取数据失败事件。 更多...
 
EventHandler< ReadDataUpdateEventArgsReadDataUpdate
 读取数据更新事件。 更多...
 
EventHandler< ReadDataDependencyAssetEventArgsReadDataDependencyAsset
 读取数据时加载依赖资源事件。 更多...
 

详细描述

全局配置管理器接口。

成员函数说明

◆ AddConfig() [1/2]

bool AddConfig ( string  configName,
bool  boolValue,
int  intValue,
float  floatValue,
string  stringValue 
)

增加指定全局配置项。

参数
configName要增加全局配置项的名称。
boolValue全局配置项布尔值。
intValue全局配置项整数值。
floatValue全局配置项浮点数值。
stringValue全局配置项字符串值。
返回
是否增加全局配置项成功。

◆ AddConfig() [2/2]

bool AddConfig ( string  configName,
string  configValue 
)

增加指定全局配置项。

参数
configName要增加全局配置项的名称。
configValue全局配置项的值。
返回
是否增加全局配置项成功。

◆ EnsureCachedBytesSize()

void EnsureCachedBytesSize ( int  ensureSize)

确保二进制流缓存分配足够大小的内存并缓存。

参数
ensureSize要确保二进制流缓存分配内存的大小。

◆ FreeCachedBytes()

void FreeCachedBytes ( )

释放缓存的二进制流。

◆ GetBool() [1/2]

bool GetBool ( string  configName)

从指定全局配置项中读取布尔值。

参数
configName要获取全局配置项的名称。
返回
读取的布尔值。

◆ GetBool() [2/2]

bool GetBool ( string  configName,
bool  defaultValue 
)

从指定全局配置项中读取布尔值。

参数
configName要获取全局配置项的名称。
defaultValue当指定的全局配置项不存在时,返回此默认值。
返回
读取的布尔值。

◆ GetFloat() [1/2]

float GetFloat ( string  configName)

从指定全局配置项中读取浮点数值。

参数
configName要获取全局配置项的名称。
返回
读取的浮点数值。

◆ GetFloat() [2/2]

float GetFloat ( string  configName,
float  defaultValue 
)

从指定全局配置项中读取浮点数值。

参数
configName要获取全局配置项的名称。
defaultValue当指定的全局配置项不存在时,返回此默认值。
返回
读取的浮点数值。

◆ GetInt() [1/2]

int GetInt ( string  configName)

从指定全局配置项中读取整数值。

参数
configName要获取全局配置项的名称。
返回
读取的整数值。

◆ GetInt() [2/2]

int GetInt ( string  configName,
int  defaultValue 
)

从指定全局配置项中读取整数值。

参数
configName要获取全局配置项的名称。
defaultValue当指定的全局配置项不存在时,返回此默认值。
返回
读取的整数值。

◆ GetString() [1/2]

string GetString ( string  configName)

从指定全局配置项中读取字符串值。

参数
configName要获取全局配置项的名称。
返回
读取的字符串值。

◆ GetString() [2/2]

string GetString ( string  configName,
string  defaultValue 
)

从指定全局配置项中读取字符串值。

参数
configName要获取全局配置项的名称。
defaultValue当指定的全局配置项不存在时,返回此默认值。
返回
读取的字符串值。

◆ HasConfig()

bool HasConfig ( string  configName)

检查是否存在指定全局配置项。

参数
configName要检查全局配置项的名称。
返回
指定的全局配置项是否存在。

◆ RemoveAllConfigs()

void RemoveAllConfigs ( )

清空所有全局配置项。

◆ RemoveConfig()

bool RemoveConfig ( string  configName)

移除指定全局配置项。

参数
configName要移除全局配置项的名称。
返回
是否移除全局配置项成功。

◆ SetConfigHelper()

void SetConfigHelper ( IConfigHelper  configHelper)

设置全局配置辅助器。

参数
configHelper全局配置辅助器。

◆ SetDataProviderHelper()

void SetDataProviderHelper ( IDataProviderHelper< IConfigManager dataProviderHelper)

设置全局配置数据提供者辅助器。

参数
dataProviderHelper全局配置数据提供者辅助器。

◆ SetResourceManager()

void SetResourceManager ( IResourceManager  resourceManager)

设置资源管理器。

参数
resourceManager资源管理器。

属性说明

◆ CachedBytesSize

int CachedBytesSize
get

获取缓冲二进制流的大小。

◆ Count

int Count
get

获取全局配置项数量。