Game Framework  2021.05.31
DefaultSettingHelper类 参考

默认游戏配置辅助器。 更多...

类 DefaultSettingHelper 继承关系图:
SettingHelperBase ISettingHelper

Public 成员函数

override bool Load ()
 加载游戏配置。 更多...
 
override bool Save ()
 保存游戏配置。 更多...
 
override string[] GetAllSettingNames ()
 获取所有游戏配置项的名称。 更多...
 
override void GetAllSettingNames (List< string > results)
 获取所有游戏配置项的名称。 更多...
 
override bool HasSetting (string settingName)
 检查是否存在指定游戏配置项。 更多...
 
override bool RemoveSetting (string settingName)
 移除指定游戏配置项。 更多...
 
override void RemoveAllSettings ()
 清空所有游戏配置项。 更多...
 
override bool GetBool (string settingName)
 从指定游戏配置项中读取布尔值。 更多...
 
override bool GetBool (string settingName, bool defaultValue)
 从指定游戏配置项中读取布尔值。 更多...
 
override void SetBool (string settingName, bool value)
 向指定游戏配置项写入布尔值。 更多...
 
override int GetInt (string settingName)
 从指定游戏配置项中读取整数值。 更多...
 
override int GetInt (string settingName, int defaultValue)
 从指定游戏配置项中读取整数值。 更多...
 
override void SetInt (string settingName, int value)
 向指定游戏配置项写入整数值。 更多...
 
override float GetFloat (string settingName)
 从指定游戏配置项中读取浮点数值。 更多...
 
override float GetFloat (string settingName, float defaultValue)
 从指定游戏配置项中读取浮点数值。 更多...
 
override void SetFloat (string settingName, float value)
 向指定游戏配置项写入浮点数值。 更多...
 
override string GetString (string settingName)
 从指定游戏配置项中读取字符串值。 更多...
 
override string GetString (string settingName, string defaultValue)
 从指定游戏配置项中读取字符串值。 更多...
 
override void SetString (string settingName, string value)
 向指定游戏配置项写入字符串值。 更多...
 
override T GetObject< T > (string settingName)
 从指定游戏配置项中读取对象。 更多...
 
override object GetObject (Type objectType, string settingName)
 从指定游戏配置项中读取对象。 更多...
 
override T GetObject< T > (string settingName, T defaultObj)
 从指定游戏配置项中读取对象。 更多...
 
override object GetObject (Type objectType, string settingName, object defaultObj)
 从指定游戏配置项中读取对象。 更多...
 
override void SetObject< T > (string settingName, T obj)
 向指定游戏配置项写入对象。 更多...
 
override void SetObject (string settingName, object obj)
 向指定游戏配置项写入对象。 更多...
 

属性

override int? Count [get]
 获取游戏配置项数量。 更多...
 
string FilePath [get]
 获取游戏配置存储文件路径。 更多...
 
DefaultSetting Setting [get]
 获取游戏配置。 更多...
 
DefaultSettingSerializer Serializer [get]
 获取游戏配置序列化器。 更多...
 
- 属性 继承自 SettingHelperBase
abstract int Count [get]
 获取游戏配置项数量。 更多...
 
- 属性 继承自 ISettingHelper
int Count [get]
 获取游戏配置项数量。 更多...
 

详细描述

默认游戏配置辅助器。

成员函数说明

◆ GetAllSettingNames() [1/2]

override string [] GetAllSettingNames ( )
virtual

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

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

实现了 SettingHelperBase.

◆ GetAllSettingNames() [2/2]

override void GetAllSettingNames ( List< string >  results)
virtual

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

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

实现了 SettingHelperBase.

◆ GetBool() [1/2]

override bool GetBool ( string  settingName)
virtual

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

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

实现了 SettingHelperBase.

◆ GetBool() [2/2]

override bool GetBool ( string  settingName,
bool  defaultValue 
)
virtual

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

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

实现了 SettingHelperBase.

◆ GetFloat() [1/2]

override float GetFloat ( string  settingName)
virtual

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

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

实现了 SettingHelperBase.

◆ GetFloat() [2/2]

override float GetFloat ( string  settingName,
float  defaultValue 
)
virtual

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

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

实现了 SettingHelperBase.

◆ GetInt() [1/2]

override int GetInt ( string  settingName)
virtual

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

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

实现了 SettingHelperBase.

◆ GetInt() [2/2]

override int GetInt ( string  settingName,
int  defaultValue 
)
virtual

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

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

实现了 SettingHelperBase.

◆ GetObject() [1/2]

override object GetObject ( Type  objectType,
string  settingName 
)
virtual

从指定游戏配置项中读取对象。

参数
objectType要读取对象的类型。
settingName要获取游戏配置项的名称。
返回
读取的对象。

实现了 SettingHelperBase.

◆ GetObject() [2/2]

override object GetObject ( Type  objectType,
string  settingName,
object  defaultObj 
)
virtual

从指定游戏配置项中读取对象。

参数
objectType要读取对象的类型。
settingName要获取游戏配置项的名称。
defaultObj当指定的游戏配置项不存在时,返回此默认对象。
返回
读取的对象。

实现了 SettingHelperBase.

◆ GetObject< T >() [1/2]

override T GetObject< T > ( string  settingName)
virtual

从指定游戏配置项中读取对象。

模板参数
T要读取对象的类型。
参数
settingName要获取游戏配置项的名称。
返回
读取的对象。

实现了 SettingHelperBase.

◆ GetObject< T >() [2/2]

override T GetObject< T > ( string  settingName,
defaultObj 
)
virtual

从指定游戏配置项中读取对象。

模板参数
T要读取对象的类型。
参数
settingName要获取游戏配置项的名称。
defaultObj当指定的游戏配置项不存在时,返回此默认对象。
返回
读取的对象。

实现了 SettingHelperBase.

◆ GetString() [1/2]

override string GetString ( string  settingName)
virtual

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

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

实现了 SettingHelperBase.

◆ GetString() [2/2]

override string GetString ( string  settingName,
string  defaultValue 
)
virtual

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

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

实现了 SettingHelperBase.

◆ HasSetting()

override bool HasSetting ( string  settingName)
virtual

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

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

实现了 SettingHelperBase.

◆ Load()

override bool Load ( )
virtual

加载游戏配置。

返回
是否加载游戏配置成功。

实现了 SettingHelperBase.

◆ RemoveAllSettings()

override void RemoveAllSettings ( )
virtual

清空所有游戏配置项。

实现了 SettingHelperBase.

◆ RemoveSetting()

override bool RemoveSetting ( string  settingName)
virtual

移除指定游戏配置项。

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

实现了 SettingHelperBase.

◆ Save()

override bool Save ( )
virtual

保存游戏配置。

返回
是否保存游戏配置成功。

实现了 SettingHelperBase.

◆ SetBool()

override void SetBool ( string  settingName,
bool  value 
)
virtual

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

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

实现了 SettingHelperBase.

◆ SetFloat()

override void SetFloat ( string  settingName,
float  value 
)
virtual

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

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

实现了 SettingHelperBase.

◆ SetInt()

override void SetInt ( string  settingName,
int  value 
)
virtual

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

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

实现了 SettingHelperBase.

◆ SetObject()

override void SetObject ( string  settingName,
object  obj 
)
virtual

向指定游戏配置项写入对象。

参数
settingName要写入游戏配置项的名称。
obj要写入的对象。

实现了 SettingHelperBase.

◆ SetObject< T >()

override void SetObject< T > ( string  settingName,
obj 
)
virtual

向指定游戏配置项写入对象。

模板参数
T要写入对象的类型。
参数
settingName要写入游戏配置项的名称。
obj要写入的对象。

实现了 SettingHelperBase.

◆ SetString()

override void SetString ( string  settingName,
string  value 
)
virtual

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

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

实现了 SettingHelperBase.

属性说明

◆ Count

override int? Count
get

获取游戏配置项数量。

◆ FilePath

string FilePath
get

获取游戏配置存储文件路径。

◆ Serializer

DefaultSettingSerializer Serializer
get

获取游戏配置序列化器。

◆ Setting

DefaultSetting Setting
get

获取游戏配置。