Game Framework  2019.11.26
ConfigComponent类 参考

全局配置组件。 更多...

类 ConfigComponent 继承关系图:
GameFrameworkComponent

Public 成员函数

void LoadConfig (string configName, string configAssetName, LoadType loadType)
 加载全局配置。 更多...
 
void LoadConfig (string configName, string configAssetName, LoadType loadType, int priority)
 加载全局配置。 更多...
 
void LoadConfig (string configName, string configAssetName, LoadType loadType, object userData)
 加载全局配置。 更多...
 
void LoadConfig (string configName, string configAssetName, LoadType loadType, int priority, object userData)
 加载全局配置。 更多...
 
bool ParseConfig (string text)
 解析全局配置。 更多...
 
bool ParseConfig (string text, object userData)
 解析全局配置。 更多...
 
bool ParseConfig (byte[] bytes)
 解析全局配置。 更多...
 
bool ParseConfig (byte[] bytes, object userData)
 解析全局配置。 更多...
 
bool ParseConfig (Stream stream)
 解析全局配置。 更多...
 
bool ParseConfig (Stream stream, object userData)
 解析全局配置。 更多...
 
bool HasConfig (string configName)
 检查是否存在指定全局配置项。 更多...
 
void RemoveConfig (string configName)
 移除指定全局配置项。 更多...
 
void RemoveAllConfigs ()
 清空所有全局配置项。 更多...
 
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)
 从指定全局配置项中读取字符串值。 更多...
 

Protected 成员函数

override void Awake ()
 游戏框架组件初始化。 更多...
 

属性

int ConfigCount [get]
 获取全局配置数量。 更多...
 

详细描述

全局配置组件。

成员函数说明

◆ Awake()

override void Awake ( )
protectedvirtual

游戏框架组件初始化。

重载 GameFrameworkComponent .

◆ 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要检查全局配置项的名称。
返回
指定的全局配置项是否存在。

◆ LoadConfig() [1/4]

void LoadConfig ( string  configName,
string  configAssetName,
LoadType  loadType 
)

加载全局配置。

参数
configName全局配置名称。
configAssetName全局配置资源名称。
loadType全局配置加载方式。

◆ LoadConfig() [2/4]

void LoadConfig ( string  configName,
string  configAssetName,
LoadType  loadType,
int  priority 
)

加载全局配置。

参数
configName全局配置名称。
configAssetName全局配置资源名称。
loadType全局配置加载方式。
priority加载全局配置资源的优先级。

◆ LoadConfig() [3/4]

void LoadConfig ( string  configName,
string  configAssetName,
LoadType  loadType,
int  priority,
object  userData 
)

加载全局配置。

参数
configName全局配置名称。
configAssetName全局配置资源名称。
loadType全局配置加载方式。
priority加载全局配置资源的优先级。
userData用户自定义数据。

◆ LoadConfig() [4/4]

void LoadConfig ( string  configName,
string  configAssetName,
LoadType  loadType,
object  userData 
)

加载全局配置。

参数
configName全局配置名称。
configAssetName全局配置资源名称。
loadType全局配置加载方式。
userData用户自定义数据。

◆ ParseConfig() [1/6]

bool ParseConfig ( byte[]  bytes)

解析全局配置。

参数
bytes要解析的全局配置二进制流。
返回
是否解析全局配置成功。

◆ ParseConfig() [2/6]

bool ParseConfig ( byte[]  bytes,
object  userData 
)

解析全局配置。

参数
bytes要解析的全局配置二进制流。
userData用户自定义数据。
返回
是否解析全局配置成功。

◆ ParseConfig() [3/6]

bool ParseConfig ( Stream  stream)

解析全局配置。

参数
stream要解析的全局配置二进制流。
返回
是否解析全局配置成功。

◆ ParseConfig() [4/6]

bool ParseConfig ( Stream  stream,
object  userData 
)

解析全局配置。

参数
stream要解析的全局配置二进制流。
userData用户自定义数据。
返回
是否解析全局配置成功。

◆ ParseConfig() [5/6]

bool ParseConfig ( string  text)

解析全局配置。

参数
text要解析的全局配置文本。
返回
是否解析全局配置成功。

◆ ParseConfig() [6/6]

bool ParseConfig ( string  text,
object  userData 
)

解析全局配置。

参数
text要解析的全局配置文本。
userData用户自定义数据。
返回
是否解析全局配置成功。

◆ RemoveAllConfigs()

void RemoveAllConfigs ( )

清空所有全局配置项。

◆ RemoveConfig()

void RemoveConfig ( string  configName)

移除指定全局配置项。

参数
configName要移除全局配置项的名称。

属性说明

◆ ConfigCount

int ConfigCount
get

获取全局配置数量。