Game Framework  2019.11.26
SettingComponent类 参考

游戏配置组件。 更多...

类 SettingComponent 继承关系图:
GameFrameworkComponent

Public 成员函数

void Save ()
 保存游戏配置。 更多...
 
bool HasSetting (string settingName)
 检查是否存在指定游戏配置项。 更多...
 
void 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)
 向指定游戏配置项写入字符串值。 更多...
 
T GetObject< T > (string settingName)
 从指定游戏配置项中读取对象。 更多...
 
object GetObject (Type objectType, string settingName)
 从指定游戏配置项中读取对象。 更多...
 
T GetObject< T > (string settingName, T defaultObj)
 从指定游戏配置项中读取对象。 更多...
 
object GetObject (Type objectType, string settingName, object defaultObj)
 从指定游戏配置项中读取对象。 更多...
 
void SetObject< T > (string settingName, T obj)
 向指定游戏配置项写入对象。 更多...
 
void SetObject (string settingName, object obj)
 向指定游戏配置项写入对象。 更多...
 

Protected 成员函数

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

详细描述

游戏配置组件。

成员函数说明

◆ Awake()

override void Awake ( )
protectedvirtual

游戏框架组件初始化。

重载 GameFrameworkComponent .

◆ 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当指定的游戏配置项不存在时,返回此默认值。
返回
读取的整数值。

◆ GetObject() [1/2]

object GetObject ( Type  objectType,
string  settingName 
)

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

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

◆ GetObject() [2/2]

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

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

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

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

T GetObject< T > ( string  settingName)

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

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

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

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

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

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

◆ 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()

void RemoveSetting ( string  settingName)

移除指定游戏配置项。

参数
settingName要移除游戏配置项的名称。

◆ Save()

void Save ( )

保存游戏配置。

◆ 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要写入的整数值。

◆ SetObject()

void SetObject ( string  settingName,
object  obj 
)

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

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

◆ SetObject< T >()

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

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

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

◆ SetString()

void SetString ( string  settingName,
string  value 
)

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

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