SettingComponent.cs 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  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;
  8. using GameFramework.Setting;
  9. using System;
  10. using System.Collections.Generic;
  11. using UnityEngine;
  12. namespace UnityGameFramework.Runtime
  13. {
  14. /// <summary>
  15. /// 游戏配置组件。
  16. /// </summary>
  17. [DisallowMultipleComponent]
  18. [AddComponentMenu("Game Framework/Setting")]
  19. public sealed class SettingComponent : GameFrameworkComponent
  20. {
  21. private ISettingManager m_SettingManager = null;
  22. [SerializeField]
  23. private string m_SettingHelperTypeName = "UnityGameFramework.Runtime.DefaultSettingHelper";
  24. [SerializeField]
  25. private SettingHelperBase m_CustomSettingHelper = null;
  26. /// <summary>
  27. /// 获取游戏配置项数量。
  28. /// </summary>
  29. public int Count
  30. {
  31. get
  32. {
  33. return m_SettingManager.Count;
  34. }
  35. }
  36. /// <summary>
  37. /// 游戏框架组件初始化。
  38. /// </summary>
  39. protected override void Awake()
  40. {
  41. base.Awake();
  42. m_SettingManager = GameFrameworkEntry.GetModule<ISettingManager>();
  43. if (m_SettingManager == null)
  44. {
  45. Log.Fatal("Setting manager is invalid.");
  46. return;
  47. }
  48. SettingHelperBase settingHelper = Helper.CreateHelper(m_SettingHelperTypeName, m_CustomSettingHelper);
  49. if (settingHelper == null)
  50. {
  51. Log.Error("Can not create setting helper.");
  52. return;
  53. }
  54. settingHelper.name = "Setting Helper";
  55. Transform transform = settingHelper.transform;
  56. transform.SetParent(this.transform);
  57. transform.localScale = Vector3.one;
  58. m_SettingManager.SetSettingHelper(settingHelper);
  59. }
  60. private void Start()
  61. {
  62. if (!m_SettingManager.Load())
  63. {
  64. Log.Error("Load settings failure.");
  65. }
  66. }
  67. /// <summary>
  68. /// 保存游戏配置。
  69. /// </summary>
  70. public void Save()
  71. {
  72. m_SettingManager.Save();
  73. }
  74. /// <summary>
  75. /// 获取所有游戏配置项的名称。
  76. /// </summary>
  77. /// <returns>所有游戏配置项的名称。</returns>
  78. public string[] GetAllSettingNames()
  79. {
  80. return m_SettingManager.GetAllSettingNames();
  81. }
  82. /// <summary>
  83. /// 获取所有游戏配置项的名称。
  84. /// </summary>
  85. /// <param name="results">所有游戏配置项的名称。</param>
  86. public void GetAllSettingNames(List<string> results)
  87. {
  88. m_SettingManager.GetAllSettingNames(results);
  89. }
  90. /// <summary>
  91. /// 检查是否存在指定游戏配置项。
  92. /// </summary>
  93. /// <param name="settingName">要检查游戏配置项的名称。</param>
  94. /// <returns>指定的游戏配置项是否存在。</returns>
  95. public bool HasSetting(string settingName)
  96. {
  97. return m_SettingManager.HasSetting(settingName);
  98. }
  99. /// <summary>
  100. /// 移除指定游戏配置项。
  101. /// </summary>
  102. /// <param name="settingName">要移除游戏配置项的名称。</param>
  103. public void RemoveSetting(string settingName)
  104. {
  105. m_SettingManager.RemoveSetting(settingName);
  106. }
  107. /// <summary>
  108. /// 清空所有游戏配置项。
  109. /// </summary>
  110. public void RemoveAllSettings()
  111. {
  112. m_SettingManager.RemoveAllSettings();
  113. }
  114. /// <summary>
  115. /// 从指定游戏配置项中读取布尔值。
  116. /// </summary>
  117. /// <param name="settingName">要获取游戏配置项的名称。</param>
  118. /// <returns>读取的布尔值。</returns>
  119. public bool GetBool(string settingName)
  120. {
  121. return m_SettingManager.GetBool(settingName);
  122. }
  123. /// <summary>
  124. /// 从指定游戏配置项中读取布尔值。
  125. /// </summary>
  126. /// <param name="settingName">要获取游戏配置项的名称。</param>
  127. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  128. /// <returns>读取的布尔值。</returns>
  129. public bool GetBool(string settingName, bool defaultValue)
  130. {
  131. return m_SettingManager.GetBool(settingName, defaultValue);
  132. }
  133. /// <summary>
  134. /// 向指定游戏配置项写入布尔值。
  135. /// </summary>
  136. /// <param name="settingName">要写入游戏配置项的名称。</param>
  137. /// <param name="value">要写入的布尔值。</param>
  138. public void SetBool(string settingName, bool value)
  139. {
  140. m_SettingManager.SetBool(settingName, value);
  141. }
  142. /// <summary>
  143. /// 从指定游戏配置项中读取整数值。
  144. /// </summary>
  145. /// <param name="settingName">要获取游戏配置项的名称。</param>
  146. /// <returns>读取的整数值。</returns>
  147. public int GetInt(string settingName)
  148. {
  149. return m_SettingManager.GetInt(settingName);
  150. }
  151. /// <summary>
  152. /// 从指定游戏配置项中读取整数值。
  153. /// </summary>
  154. /// <param name="settingName">要获取游戏配置项的名称。</param>
  155. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  156. /// <returns>读取的整数值。</returns>
  157. public int GetInt(string settingName, int defaultValue)
  158. {
  159. return m_SettingManager.GetInt(settingName, defaultValue);
  160. }
  161. /// <summary>
  162. /// 向指定游戏配置项写入整数值。
  163. /// </summary>
  164. /// <param name="settingName">要写入游戏配置项的名称。</param>
  165. /// <param name="value">要写入的整数值。</param>
  166. public void SetInt(string settingName, int value)
  167. {
  168. m_SettingManager.SetInt(settingName, value);
  169. }
  170. /// <summary>
  171. /// 从指定游戏配置项中读取浮点数值。
  172. /// </summary>
  173. /// <param name="settingName">要获取游戏配置项的名称。</param>
  174. /// <returns>读取的浮点数值。</returns>
  175. public float GetFloat(string settingName)
  176. {
  177. return m_SettingManager.GetFloat(settingName);
  178. }
  179. /// <summary>
  180. /// 从指定游戏配置项中读取浮点数值。
  181. /// </summary>
  182. /// <param name="settingName">要获取游戏配置项的名称。</param>
  183. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  184. /// <returns>读取的浮点数值。</returns>
  185. public float GetFloat(string settingName, float defaultValue)
  186. {
  187. return m_SettingManager.GetFloat(settingName, defaultValue);
  188. }
  189. /// <summary>
  190. /// 向指定游戏配置项写入浮点数值。
  191. /// </summary>
  192. /// <param name="settingName">要写入游戏配置项的名称。</param>
  193. /// <param name="value">要写入的浮点数值。</param>
  194. public void SetFloat(string settingName, float value)
  195. {
  196. m_SettingManager.SetFloat(settingName, value);
  197. }
  198. /// <summary>
  199. /// 从指定游戏配置项中读取字符串值。
  200. /// </summary>
  201. /// <param name="settingName">要获取游戏配置项的名称。</param>
  202. /// <returns>读取的字符串值。</returns>
  203. public string GetString(string settingName)
  204. {
  205. return m_SettingManager.GetString(settingName);
  206. }
  207. /// <summary>
  208. /// 从指定游戏配置项中读取字符串值。
  209. /// </summary>
  210. /// <param name="settingName">要获取游戏配置项的名称。</param>
  211. /// <param name="defaultValue">当指定的游戏配置项不存在时,返回此默认值。</param>
  212. /// <returns>读取的字符串值。</returns>
  213. public string GetString(string settingName, string defaultValue)
  214. {
  215. return m_SettingManager.GetString(settingName, defaultValue);
  216. }
  217. /// <summary>
  218. /// 向指定游戏配置项写入字符串值。
  219. /// </summary>
  220. /// <param name="settingName">要写入游戏配置项的名称。</param>
  221. /// <param name="value">要写入的字符串值。</param>
  222. public void SetString(string settingName, string value)
  223. {
  224. m_SettingManager.SetString(settingName, value);
  225. }
  226. /// <summary>
  227. /// 从指定游戏配置项中读取对象。
  228. /// </summary>
  229. /// <typeparam name="T">要读取对象的类型。</typeparam>
  230. /// <param name="settingName">要获取游戏配置项的名称。</param>
  231. /// <returns>读取的对象。</returns>
  232. public T GetObject<T>(string settingName)
  233. {
  234. return m_SettingManager.GetObject<T>(settingName);
  235. }
  236. /// <summary>
  237. /// 从指定游戏配置项中读取对象。
  238. /// </summary>
  239. /// <param name="objectType">要读取对象的类型。</param>
  240. /// <param name="settingName">要获取游戏配置项的名称。</param>
  241. /// <returns>读取的对象。</returns>
  242. public object GetObject(Type objectType, string settingName)
  243. {
  244. return m_SettingManager.GetObject(objectType, settingName);
  245. }
  246. /// <summary>
  247. /// 从指定游戏配置项中读取对象。
  248. /// </summary>
  249. /// <typeparam name="T">要读取对象的类型。</typeparam>
  250. /// <param name="settingName">要获取游戏配置项的名称。</param>
  251. /// <param name="defaultObj">当指定的游戏配置项不存在时,返回此默认对象。</param>
  252. /// <returns>读取的对象。</returns>
  253. public T GetObject<T>(string settingName, T defaultObj)
  254. {
  255. return m_SettingManager.GetObject(settingName, defaultObj);
  256. }
  257. /// <summary>
  258. /// 从指定游戏配置项中读取对象。
  259. /// </summary>
  260. /// <param name="objectType">要读取对象的类型。</param>
  261. /// <param name="settingName">要获取游戏配置项的名称。</param>
  262. /// <param name="defaultObj">当指定的游戏配置项不存在时,返回此默认对象。</param>
  263. /// <returns>读取的对象。</returns>
  264. public object GetObject(Type objectType, string settingName, object defaultObj)
  265. {
  266. return m_SettingManager.GetObject(objectType, settingName, defaultObj);
  267. }
  268. /// <summary>
  269. /// 向指定游戏配置项写入对象。
  270. /// </summary>
  271. /// <typeparam name="T">要写入对象的类型。</typeparam>
  272. /// <param name="settingName">要写入游戏配置项的名称。</param>
  273. /// <param name="obj">要写入的对象。</param>
  274. public void SetObject<T>(string settingName, T obj)
  275. {
  276. m_SettingManager.SetObject(settingName, obj);
  277. }
  278. /// <summary>
  279. /// 向指定游戏配置项写入对象。
  280. /// </summary>
  281. /// <param name="settingName">要写入游戏配置项的名称。</param>
  282. /// <param name="obj">要写入的对象。</param>
  283. public void SetObject(string settingName, object obj)
  284. {
  285. m_SettingManager.SetObject(settingName, obj);
  286. }
  287. }
  288. }