PlayerPrefsSettingHelper.cs 12 KB

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