ISettingHelper.cs 8.3 KB

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