SettingHelperBase.cs 9.0 KB

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