ConfigHelperBase.cs 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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.Config;
  9. using UnityEngine;
  10. namespace UnityGameFramework.Runtime
  11. {
  12. /// <summary>
  13. /// 全局配置辅助器基类。
  14. /// </summary>
  15. public abstract class ConfigHelperBase : MonoBehaviour, IDataProviderHelper<IConfigManager>, IConfigHelper
  16. {
  17. /// <summary>
  18. /// 读取全局配置。
  19. /// </summary>
  20. /// <param name="configManager">全局配置管理器。</param>
  21. /// <param name="configAssetName">全局配置资源名称。</param>
  22. /// <param name="configAsset">全局配置资源。</param>
  23. /// <param name="userData">用户自定义数据。</param>
  24. /// <returns>是否读取全局配置成功。</returns>
  25. public abstract bool ReadData(IConfigManager configManager, string configAssetName, object configAsset, object userData);
  26. /// <summary>
  27. /// 读取全局配置。
  28. /// </summary>
  29. /// <param name="configManager">全局配置管理器。</param>
  30. /// <param name="configAssetName">全局配置资源名称。</param>
  31. /// <param name="configBytes">全局配置二进制流。</param>
  32. /// <param name="startIndex">全局配置二进制流的起始位置。</param>
  33. /// <param name="length">全局配置二进制流的长度。</param>
  34. /// <param name="userData">用户自定义数据。</param>
  35. /// <returns>是否读取全局配置成功。</returns>
  36. public abstract bool ReadData(IConfigManager configManager, string configAssetName, byte[] configBytes, int startIndex, int length, object userData);
  37. /// <summary>
  38. /// 解析全局配置。
  39. /// </summary>
  40. /// <param name="configManager">全局配置管理器。</param>
  41. /// <param name="configString">要解析的全局配置字符串。</param>
  42. /// <param name="userData">用户自定义数据。</param>
  43. /// <returns>是否解析全局配置成功。</returns>
  44. public abstract bool ParseData(IConfigManager configManager, string configString, object userData);
  45. /// <summary>
  46. /// 解析全局配置。
  47. /// </summary>
  48. /// <param name="configManager">全局配置管理器。</param>
  49. /// <param name="configBytes">要解析的全局配置二进制流。</param>
  50. /// <param name="startIndex">全局配置二进制流的起始位置。</param>
  51. /// <param name="length">全局配置二进制流的长度。</param>
  52. /// <param name="userData">用户自定义数据。</param>
  53. /// <returns>是否解析全局配置成功。</returns>
  54. public abstract bool ParseData(IConfigManager configManager, byte[] configBytes, int startIndex, int length, object userData);
  55. /// <summary>
  56. /// 释放全局配置资源。
  57. /// </summary>
  58. /// <param name="configManager">全局配置管理器。</param>
  59. /// <param name="configAsset">要释放的全局配置资源。</param>
  60. public abstract void ReleaseDataAsset(IConfigManager configManager, object configAsset);
  61. }
  62. }