//------------------------------------------------------------
// Game Framework
// Copyright © 2013-2021 loyalsoft. All rights reserved.
// Homepage: http://www.game7000.com/
// Feedback: http://www.game7000.com/
//------------------------------------------------------------
using System;
using System.Collections.Generic;
namespace GameFramework.Setting
{
///
/// 游戏配置辅助器接口。
///
public interface ISettingHelper
{
///
/// 获取游戏配置项数量。
///
int Count
{
get;
}
///
/// 加载游戏配置。
///
/// 是否加载游戏配置成功。
bool Load();
///
/// 保存游戏配置。
///
/// 是否保存游戏配置成功。
bool Save();
///
/// 获取所有游戏配置项的名称。
///
/// 所有游戏配置项的名称。
string[] GetAllSettingNames();
///
/// 获取所有游戏配置项的名称。
///
/// 所有游戏配置项的名称。
void GetAllSettingNames(List 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);
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 读取的对象。
T GetObject(string settingName);
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 读取的对象。
object GetObject(Type objectType, string settingName);
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时，返回此默认对象。
/// 读取的对象。
T GetObject(string settingName, T defaultObj);
///
/// 从指定游戏配置项中读取对象。
///
/// 要读取对象的类型。
/// 要获取游戏配置项的名称。
/// 当指定的游戏配置项不存在时，返回此默认对象。
/// 读取的对象。
object GetObject(Type objectType, string settingName, object defaultObj);
///
/// 向指定游戏配置项写入对象。
///
/// 要写入对象的类型。
/// 要写入游戏配置项的名称。
/// 要写入的对象。
void SetObject(string settingName, T obj);
///
/// 向指定游戏配置项写入对象。
///
/// 要写入游戏配置项的名称。
/// 要写入的对象。
void SetObject(string settingName, object obj);
}
}