ISettingManager.cs 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. //------------------------------------------------------------
  2. // Game Framework
  3. // Copyright © 2013-2021 loyalsoft. All rights reserved.
  4. // Homepage: http://www.game7000.com/
  5. // Feedback: http://www.game7000.com/
  6. //------------------------------------------------------------
  7. using System;
  8. using System.Collections.Generic;
  9. namespace GameFramework.Setting
  10. {
  11. /// <summary>
  12. /// 游戏配置管理器接口。
  13. /// </summary>
  14. public interface ISettingManager
  15. {
  16. /// <summary>
  17. /// 获取游戏配置项数量。
  18. /// </summary>
  19. int Count
  20. {
  21. get;
  22. }
  23. /// <summary>
  24. /// 设置游戏配置辅助器。
  25. /// </summary>
  26. /// <param name="settingHelper">游戏配置辅助器。</param>
  27. void SetSettingHelper(ISettingHelper settingHelper);
  28. /// <summary>
  29. /// 加载游戏配置。
  30. /// </summary>
  31. /// <returns>是否加载游戏配置成功。</returns>
  32. bool Load();
  33. /// <summary>
  34. /// 保存游戏配置。
  35. /// </summary>
  36. /// <returns>是否保存游戏配置成功。</returns>
  37. bool Save();
  38. /// <summary>
  39. /// 获取所有游戏配置项的名称。
  40. /// </summary>
  41. /// <returns>所有游戏配置项的名称。</returns>
  42. string[] GetAllSettingNames();
  43. /// <summary>
  44. /// 获取所有游戏配置项的名称。
  45. /// </summary>
  46. /// <param name="results">所有游戏配置项的名称。</param>
  47. void GetAllSettingNames(List<string> results);
  48. /// <summary>
  49. /// 检查是否存在指定游戏配置项。
  50. /// </summary>
  51. /// <param name="settingName">要检查游戏配置项的名称。</param>
  52. /// <returns>指定的游戏配置项是否存在。</returns>
  53. bool HasSetting(string settingName);
  54. /// <summary>
  55. /// 移除指定游戏配置项。
  56. /// </summary>
  57. /// <param name="settingName">要移除游戏配置项的名称。</param>
  58. /// <returns>是否移除指定游戏配置项成功。</returns>
  59. bool RemoveSetting(string settingName);
  60. /// <summary>
  61. /// 清空所有游戏配置项。
  62. /// </summary>
  63. void RemoveAllSettings();
  64. /// <summary>
  65. /// 从指定游戏配置项中读取布尔值。
  66. /// </summary>
  67. /// <param name="settingName">要获取游戏配置项的名称。</param>
  68. /// <returns>读取的布尔值。</returns>
  69. bool GetBool(string settingName);
  70. /// <summary>
  71. /// 从指定游戏配置项中读取布尔值。
  72. /// </summary>
  73. /// <param name="settingName">要获取游戏配置项的名称。</param>
  74. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  75. /// <returns>读取的布尔值。</returns>
  76. bool GetBool(string settingName, bool defaultValue);
  77. /// <summary>
  78. /// 向指定游戏配置项写入布尔值。
  79. /// </summary>
  80. /// <param name="settingName">要写入游戏配置项的名称。</param>
  81. /// <param name="value">要写入的布尔值。</param>
  82. void SetBool(string settingName, bool value);
  83. /// <summary>
  84. /// 从指定游戏配置项中读取整数值。
  85. /// </summary>
  86. /// <param name="settingName">要获取游戏配置项的名称。</param>
  87. /// <returns>读取的整数值。</returns>
  88. int GetInt(string settingName);
  89. /// <summary>
  90. /// 从指定游戏配置项中读取整数值。
  91. /// </summary>
  92. /// <param name="settingName">要获取游戏配置项的名称。</param>
  93. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  94. /// <returns>读取的整数值。</returns>
  95. int GetInt(string settingName, int defaultValue);
  96. /// <summary>
  97. /// 向指定游戏配置项写入整数值。
  98. /// </summary>
  99. /// <param name="settingName">要写入游戏配置项的名称。</param>
  100. /// <param name="value">要写入的整数值。</param>
  101. void SetInt(string settingName, int value);
  102. /// <summary>
  103. /// 从指定游戏配置项中读取浮点数值。
  104. /// </summary>
  105. /// <param name="settingName">要获取游戏配置项的名称。</param>
  106. /// <returns>读取的浮点数值。</returns>
  107. float GetFloat(string settingName);
  108. /// <summary>
  109. /// 从指定游戏配置项中读取浮点数值。
  110. /// </summary>
  111. /// <param name="settingName">要获取游戏配置项的名称。</param>
  112. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  113. /// <returns>读取的浮点数值。</returns>
  114. float GetFloat(string settingName, float defaultValue);
  115. /// <summary>
  116. /// 向指定游戏配置项写入浮点数值。
  117. /// </summary>
  118. /// <param name="settingName">要写入游戏配置项的名称。</param>
  119. /// <param name="value">要写入的浮点数值。</param>
  120. void SetFloat(string settingName, float value);
  121. /// <summary>
  122. /// 从指定游戏配置项中读取字符串值。
  123. /// </summary>
  124. /// <param name="settingName">要获取游戏配置项的名称。</param>
  125. /// <returns>读取的字符串值。</returns>
  126. string GetString(string settingName);
  127. /// <summary>
  128. /// 从指定游戏配置项中读取字符串值。
  129. /// </summary>
  130. /// <param name="settingName">要获取游戏配置项的名称。</param>
  131. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  132. /// <returns>读取的字符串值。</returns>
  133. string GetString(string settingName, string defaultValue);
  134. /// <summary>
  135. /// 向指定游戏配置项写入字符串值。
  136. /// </summary>
  137. /// <param name="settingName">要写入游戏配置项的名称。</param>
  138. /// <param name="value">要写入的字符串值。</param>
  139. void SetString(string settingName, string value);
  140. /// <summary>
  141. /// 从指定游戏配置项中读取对象。
  142. /// </summary>
  143. /// <typeparam name="T">要读取对象的类型。</typeparam>
  144. /// <param name="settingName">要获取游戏配置项的名称。</param>
  145. /// <returns>读取的对象。</returns>
  146. T GetObject<T>(string settingName);
  147. /// <summary>
  148. /// 从指定游戏配置项中读取对象。
  149. /// </summary>
  150. /// <param name="objectType">要读取对象的类型。</param>
  151. /// <param name="settingName">要获取游戏配置项的名称。</param>
  152. /// <returns>读取的对象。</returns>
  153. object GetObject(Type objectType, string settingName);
  154. /// <summary>
  155. /// 从指定游戏配置项中读取对象。
  156. /// </summary>
  157. /// <typeparam name="T">要读取对象的类型。</typeparam>
  158. /// <param name="settingName">要获取游戏配置项的名称。</param>
  159. /// <param name="defaultObj">当指定的游戏配置项不存在时,返回此默认对象。</param>
  160. /// <returns>读取的对象。</returns>
  161. T GetObject<T>(string settingName, T defaultObj);
  162. /// <summary>
  163. /// 从指定游戏配置项中读取对象。
  164. /// </summary>
  165. /// <param name="objectType">要读取对象的类型。</param>
  166. /// <param name="settingName">要获取游戏配置项的名称。</param>
  167. /// <param name="defaultObj">当指定的游戏配置项不存在时,返回此默认对象。</param>
  168. /// <returns>读取的对象。</returns>
  169. object GetObject(Type objectType, string settingName, object defaultObj);
  170. /// <summary>
  171. /// 向指定游戏配置项写入对象。
  172. /// </summary>
  173. /// <typeparam name="T">要写入对象的类型。</typeparam>
  174. /// <param name="settingName">要写入游戏配置项的名称。</param>
  175. /// <param name="obj">要写入的对象。</param>
  176. void SetObject<T>(string settingName, T obj);
  177. /// <summary>
  178. /// 向指定游戏配置项写入对象。
  179. /// </summary>
  180. /// <param name="settingName">要写入游戏配置项的名称。</param>
  181. /// <param name="obj">要写入的对象。</param>
  182. void SetObject(string settingName, object obj);
  183. }
  184. }