Game Framework  2021.05.31
DefaultSetting类 参考

默认游戏配置。 更多...

Public 成员函数

 DefaultSetting ()
 初始化本地版本资源列表的新实例。 更多...
 
string[] GetAllSettingNames ()
 获取所有游戏配置项的名称。 更多...
 
void GetAllSettingNames (List< string > results)
 获取所有游戏配置项的名称。 更多...
 
bool HasSetting (string settingName)
 检查是否存在指定游戏配置项。 更多...
 
bool RemoveSetting (string settingName)
 移除指定游戏配置项。 更多...
 
void RemoveAllSettings ()
 清空所有游戏配置项。 更多...
 
bool GetBool (string settingName)
 从指定游戏配置项中读取布尔值。 更多...
 
bool GetBool (string settingName, bool defaultValue)
 从指定游戏配置项中读取布尔值。 更多...
 
void SetBool (string settingName, bool value)
 向指定游戏配置项写入布尔值。 更多...
 
int GetInt (string settingName)
 从指定游戏配置项中读取整数值。 更多...
 
int GetInt (string settingName, int defaultValue)
 从指定游戏配置项中读取整数值。 更多...
 
void SetInt (string settingName, int value)
 向指定游戏配置项写入整数值。 更多...
 
float GetFloat (string settingName)
 从指定游戏配置项中读取浮点数值。 更多...
 
float GetFloat (string settingName, float defaultValue)
 从指定游戏配置项中读取浮点数值。 更多...
 
void SetFloat (string settingName, float value)
 向指定游戏配置项写入浮点数值。 更多...
 
string GetString (string settingName)
 从指定游戏配置项中读取字符串值。 更多...
 
string GetString (string settingName, string defaultValue)
 从指定游戏配置项中读取字符串值。 更多...
 
void SetString (string settingName, string value)
 向指定游戏配置项写入字符串值。 更多...
 
void Serialize (Stream stream)
 序列化数据。 更多...
 
void Deserialize (Stream stream)
 反序列化数据。 更多...
 

属性

int Count [get]
 获取游戏配置项数量。 更多...
 

详细描述

默认游戏配置。

构造及析构函数说明

◆ DefaultSetting()

初始化本地版本资源列表的新实例。

成员函数说明

◆ Deserialize()

void Deserialize ( Stream  stream)

反序列化数据。

参数
stream指定流。

◆ GetAllSettingNames() [1/2]

string [] GetAllSettingNames ( )

获取所有游戏配置项的名称。

返回
所有游戏配置项的名称。

◆ GetAllSettingNames() [2/2]

void GetAllSettingNames ( List< string >  results)

获取所有游戏配置项的名称。

参数
results所有游戏配置项的名称。

◆ GetBool() [1/2]

bool GetBool ( string  settingName)

从指定游戏配置项中读取布尔值。

参数
settingName要获取游戏配置项的名称。
返回
读取的布尔值。

◆ GetBool() [2/2]

bool GetBool ( string  settingName,
bool  defaultValue 
)

从指定游戏配置项中读取布尔值。

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

◆ GetFloat() [1/2]

float GetFloat ( string  settingName)

从指定游戏配置项中读取浮点数值。

参数
settingName要获取游戏配置项的名称。
返回
读取的浮点数值。

◆ GetFloat() [2/2]

float GetFloat ( string  settingName,
float  defaultValue 
)

从指定游戏配置项中读取浮点数值。

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

◆ GetInt() [1/2]

int GetInt ( string  settingName)

从指定游戏配置项中读取整数值。

参数
settingName要获取游戏配置项的名称。
返回
读取的整数值。

◆ GetInt() [2/2]

int GetInt ( string  settingName,
int  defaultValue 
)

从指定游戏配置项中读取整数值。

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

◆ GetString() [1/2]

string GetString ( string  settingName)

从指定游戏配置项中读取字符串值。

参数
settingName要获取游戏配置项的名称。
返回
读取的字符串值。

◆ GetString() [2/2]

string GetString ( string  settingName,
string  defaultValue 
)

从指定游戏配置项中读取字符串值。

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

◆ HasSetting()

bool HasSetting ( string  settingName)

检查是否存在指定游戏配置项。

参数
settingName要检查游戏配置项的名称。
返回
指定的游戏配置项是否存在。

◆ RemoveAllSettings()

void RemoveAllSettings ( )

清空所有游戏配置项。

◆ RemoveSetting()

bool RemoveSetting ( string  settingName)

移除指定游戏配置项。

参数
settingName要移除游戏配置项的名称。
返回
是否移除指定游戏配置项成功。

◆ Serialize()

void Serialize ( Stream  stream)

序列化数据。

参数
stream目标流。

◆ SetBool()

void SetBool ( string  settingName,
bool  value 
)

向指定游戏配置项写入布尔值。

参数
settingName要写入游戏配置项的名称。
value要写入的布尔值。

◆ SetFloat()

void SetFloat ( string  settingName,
float  value 
)

向指定游戏配置项写入浮点数值。

参数
settingName要写入游戏配置项的名称。
value要写入的浮点数值。

◆ SetInt()

void SetInt ( string  settingName,
int  value 
)

向指定游戏配置项写入整数值。

参数
settingName要写入游戏配置项的名称。
value要写入的整数值。

◆ SetString()

void SetString ( string  settingName,
string  value 
)

向指定游戏配置项写入字符串值。

参数
settingName要写入游戏配置项的名称。
value要写入的字符串值。

属性说明

◆ Count

int Count
get

获取游戏配置项数量。