ConfigComponent类 参考

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

类 ConfigComponent 继承关系图:

Public 成员函数
void	EnsureCachedBytesSize (int ensureSize)
	确保二进制流缓存分配足够大小的内存并缓存。 更多...
void	FreeCachedBytes ()
	释放缓存的二进制流。 更多...
void	ReadData (string configAssetName)
	读取全局配置。 更多...
void	ReadData (string configAssetName, int priority)
	读取全局配置。 更多...
void	ReadData (string configAssetName, object userData)
	读取全局配置。 更多...
void	ReadData (string configAssetName, int priority, object userData)
	读取全局配置。 更多...
bool	ParseData (string configString)
	解析全局配置。 更多...
bool	ParseData (string configString, object userData)
	解析全局配置。 更多...
bool	ParseData (byte[] configBytes)
	解析全局配置。 更多...
bool	ParseData (byte[] configBytes, object userData)
	解析全局配置。 更多...
bool	ParseData (byte[] configBytes, int startIndex, int length)
	解析全局配置。 更多...
bool	ParseData (byte[] configBytes, int startIndex, int length, object userData)
	解析全局配置。 更多...
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, bool boolValue, int intValue, float floatValue, string stringValue)
	增加指定全局配置项。 更多...
bool	RemoveConfig (string configName)
	移除指定全局配置项。 更多...
void	RemoveAllConfigs ()
	清空所有全局配置项。 更多...

Protected 成员函数
override void	Awake ()
	游戏框架组件初始化。 更多...

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

详细描述

全局配置组件。

成员函数说明

AddConfig()

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

增加指定全局配置项。

参数

configName	要增加全局配置项的名称。
boolValue	全局配置项布尔值。
intValue	全局配置项整数值。
floatValue	全局配置项浮点数值。
stringValue	全局配置项字符串值。

返回

是否增加全局配置项成功。

Awake()

override void Awake ( )

protectedvirtual

游戏框架组件初始化。

重载 GameFrameworkComponent .

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

要检查全局配置项的名称。

返回

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

ParseData() [1/6]

bool ParseData

(

byte[]

configBytes

)

解析全局配置。

参数

configBytes

要解析的全局配置二进制流。

返回

是否解析全局配置成功。

ParseData() [2/6]

bool ParseData	(	byte[]	configBytes,
		int	startIndex,
		int	length
	)

解析全局配置。

参数

configBytes	要解析的全局配置二进制流。
startIndex	全局配置二进制流的起始位置。
length	全局配置二进制流的长度。

返回

是否解析全局配置成功。

ParseData() [3/6]

bool ParseData	(	byte[]	configBytes,
		int	startIndex,
		int	length,
		object	userData
	)

解析全局配置。

参数

configBytes	要解析的全局配置二进制流。
startIndex	全局配置二进制流的起始位置。
length	全局配置二进制流的长度。
userData	用户自定义数据。

返回

是否解析全局配置成功。

ParseData() [4/6]

bool ParseData	(	byte[]	configBytes,
		object	userData
	)

解析全局配置。

参数

configBytes	要解析的全局配置二进制流。
userData	用户自定义数据。

返回

是否解析全局配置成功。

ParseData() [5/6]

bool ParseData

(

string

configString

)

解析全局配置。

参数

configString

要解析的全局配置字符串。

返回

是否解析全局配置成功。

ParseData() [6/6]

bool ParseData	(	string	configString,
		object	userData
	)

解析全局配置。

参数

configString	要解析的全局配置字符串。
userData	用户自定义数据。

返回

是否解析全局配置成功。

ReadData() [1/4]

void ReadData

(

string

configAssetName

)

读取全局配置。

参数

configAssetName

全局配置资源名称。

ReadData() [2/4]

void ReadData	(	string	configAssetName,
		int	priority
	)

读取全局配置。

参数

configAssetName	全局配置资源名称。
priority	加载全局配置资源的优先级。

ReadData() [3/4]

void ReadData	(	string	configAssetName,
		int	priority,
		object	userData
	)

读取全局配置。

参数

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

ReadData() [4/4]

void ReadData	(	string	configAssetName,
		object	userData
	)

读取全局配置。

参数

configAssetName	全局配置资源名称。
userData	用户自定义数据。

RemoveAllConfigs()

void RemoveAllConfigs

(

)

清空所有全局配置项。

RemoveConfig()

bool RemoveConfig

(

string

configName

)

移除指定全局配置项。

参数

configName

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

返回

是否移除全局配置项成功。

属性说明

CachedBytesSize

int CachedBytesSize

get

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

Count

int Count

get

获取全局配置项数量。