Game Framework  2021.05.31
Public 成员函数 | 属性 | 所有成员列表
SettingHelperBase类 参考abstract

游戏配置辅助器基类。 更多...

类 SettingHelperBase 继承关系图:
ISettingHelper DefaultSettingHelper PlayerPrefsSettingHelper

Public 成员函数

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

属性

abstract int Count [get]
 获取游戏配置项数量。 更多...
 
- 属性 继承自 ISettingHelper
int Count [get]
 获取游戏配置项数量。 更多...
 

详细描述

游戏配置辅助器基类。

成员函数说明

◆ GetAllSettingNames() [1/2]

abstract string [] GetAllSettingNames ( )
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetAllSettingNames() [2/2]

abstract void GetAllSettingNames ( List< string >  results)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetBool() [1/2]

abstract bool GetBool ( string  settingName)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetBool() [2/2]

abstract bool GetBool ( string  settingName,
bool  defaultValue 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetFloat() [1/2]

abstract float GetFloat ( string  settingName)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetFloat() [2/2]

abstract float GetFloat ( string  settingName,
float  defaultValue 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetInt() [1/2]

abstract int GetInt ( string  settingName)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetInt() [2/2]

abstract int GetInt ( string  settingName,
int  defaultValue 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetObject() [1/2]

abstract object GetObject ( Type  objectType,
string  settingName 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetObject() [2/2]

abstract object GetObject ( Type  objectType,
string  settingName,
object  defaultObj 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

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

abstract T GetObject< T > ( string  settingName)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

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

abstract T GetObject< T > ( string  settingName,
T  defaultObj 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetString() [1/2]

abstract string GetString ( string  settingName)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ GetString() [2/2]

abstract string GetString ( string  settingName,
string  defaultValue 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ HasSetting()

abstract bool HasSetting ( string  settingName)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ Load()

abstract bool Load ( )
pure virtual

加载游戏配置。

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ RemoveAllSettings()

abstract void RemoveAllSettings ( )
pure virtual

清空所有游戏配置项。

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ RemoveSetting()

abstract bool RemoveSetting ( string  settingName)
pure virtual

移除指定游戏配置项。

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ Save()

abstract bool Save ( )
pure virtual

保存游戏配置。

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ SetBool()

abstract void SetBool ( string  settingName,
bool  value 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ SetFloat()

abstract void SetFloat ( string  settingName,
float  value 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ SetInt()

abstract void SetInt ( string  settingName,
int  value 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ SetObject()

abstract void SetObject ( string  settingName,
object  obj 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ SetObject< T >()

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

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

◆ SetString()

abstract void SetString ( string  settingName,
string  value 
)
pure virtual

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

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

实现了 ISettingHelper.

在 PlayerPrefsSettingHelper , 以及 DefaultSettingHelper 内被实现.

属性说明

◆ Count

abstract int Count
get

获取游戏配置项数量。