IConfigManager.cs 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  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.Resource;
  8. namespace GameFramework.Config
  9. {
  10. /// <summary>
  11. /// 全局配置管理器接口。
  12. /// </summary>
  13. public interface IConfigManager : IDataProvider<IConfigManager>
  14. {
  15. /// <summary>
  16. /// 获取全局配置项数量。
  17. /// </summary>
  18. int Count
  19. {
  20. get;
  21. }
  22. /// <summary>
  23. /// 获取缓冲二进制流的大小。
  24. /// </summary>
  25. int CachedBytesSize
  26. {
  27. get;
  28. }
  29. /// <summary>
  30. /// 设置资源管理器。
  31. /// </summary>
  32. /// <param name="resourceManager">资源管理器。</param>
  33. void SetResourceManager(IResourceManager resourceManager);
  34. /// <summary>
  35. /// 设置全局配置数据提供者辅助器。
  36. /// </summary>
  37. /// <param name="dataProviderHelper">全局配置数据提供者辅助器。</param>
  38. void SetDataProviderHelper(IDataProviderHelper<IConfigManager> dataProviderHelper);
  39. /// <summary>
  40. /// 设置全局配置辅助器。
  41. /// </summary>
  42. /// <param name="configHelper">全局配置辅助器。</param>
  43. void SetConfigHelper(IConfigHelper configHelper);
  44. /// <summary>
  45. /// 确保二进制流缓存分配足够大小的内存并缓存。
  46. /// </summary>
  47. /// <param name="ensureSize">要确保二进制流缓存分配内存的大小。</param>
  48. void EnsureCachedBytesSize(int ensureSize);
  49. /// <summary>
  50. /// 释放缓存的二进制流。
  51. /// </summary>
  52. void FreeCachedBytes();
  53. /// <summary>
  54. /// 检查是否存在指定全局配置项。
  55. /// </summary>
  56. /// <param name="configName">要检查全局配置项的名称。</param>
  57. /// <returns>指定的全局配置项是否存在。</returns>
  58. bool HasConfig(string configName);
  59. /// <summary>
  60. /// 从指定全局配置项中读取布尔值。
  61. /// </summary>
  62. /// <param name="configName">要获取全局配置项的名称。</param>
  63. /// <returns>读取的布尔值。</returns>
  64. bool GetBool(string configName);
  65. /// <summary>
  66. /// 从指定全局配置项中读取布尔值。
  67. /// </summary>
  68. /// <param name="configName">要获取全局配置项的名称。</param>
  69. /// <param name="defaultValue">当指定的全局配置项不存在时,返回此默认值。</param>
  70. /// <returns>读取的布尔值。</returns>
  71. bool GetBool(string configName, bool defaultValue);
  72. /// <summary>
  73. /// 从指定全局配置项中读取整数值。
  74. /// </summary>
  75. /// <param name="configName">要获取全局配置项的名称。</param>
  76. /// <returns>读取的整数值。</returns>
  77. int GetInt(string configName);
  78. /// <summary>
  79. /// 从指定全局配置项中读取整数值。
  80. /// </summary>
  81. /// <param name="configName">要获取全局配置项的名称。</param>
  82. /// <param name="defaultValue">当指定的全局配置项不存在时,返回此默认值。</param>
  83. /// <returns>读取的整数值。</returns>
  84. int GetInt(string configName, int defaultValue);
  85. /// <summary>
  86. /// 从指定全局配置项中读取浮点数值。
  87. /// </summary>
  88. /// <param name="configName">要获取全局配置项的名称。</param>
  89. /// <returns>读取的浮点数值。</returns>
  90. float GetFloat(string configName);
  91. /// <summary>
  92. /// 从指定全局配置项中读取浮点数值。
  93. /// </summary>
  94. /// <param name="configName">要获取全局配置项的名称。</param>
  95. /// <param name="defaultValue">当指定的全局配置项不存在时,返回此默认值。</param>
  96. /// <returns>读取的浮点数值。</returns>
  97. float GetFloat(string configName, float defaultValue);
  98. /// <summary>
  99. /// 从指定全局配置项中读取字符串值。
  100. /// </summary>
  101. /// <param name="configName">要获取全局配置项的名称。</param>
  102. /// <returns>读取的字符串值。</returns>
  103. string GetString(string configName);
  104. /// <summary>
  105. /// 从指定全局配置项中读取字符串值。
  106. /// </summary>
  107. /// <param name="configName">要获取全局配置项的名称。</param>
  108. /// <param name="defaultValue">当指定的全局配置项不存在时,返回此默认值。</param>
  109. /// <returns>读取的字符串值。</returns>
  110. string GetString(string configName, string defaultValue);
  111. /// <summary>
  112. /// 增加指定全局配置项。
  113. /// </summary>
  114. /// <param name="configName">要增加全局配置项的名称。</param>
  115. /// <param name="configValue">全局配置项的值。</param>
  116. /// <returns>是否增加全局配置项成功。</returns>
  117. bool AddConfig(string configName, string configValue);
  118. /// <summary>
  119. /// 增加指定全局配置项。
  120. /// </summary>
  121. /// <param name="configName">要增加全局配置项的名称。</param>
  122. /// <param name="boolValue">全局配置项布尔值。</param>
  123. /// <param name="intValue">全局配置项整数值。</param>
  124. /// <param name="floatValue">全局配置项浮点数值。</param>
  125. /// <param name="stringValue">全局配置项字符串值。</param>
  126. /// <returns>是否增加全局配置项成功。</returns>
  127. bool AddConfig(string configName, bool boolValue, int intValue, float floatValue, string stringValue);
  128. /// <summary>
  129. /// 移除指定全局配置项。
  130. /// </summary>
  131. /// <param name="configName">要移除全局配置项的名称。</param>
  132. /// <returns>是否移除全局配置项成功。</returns>
  133. bool RemoveConfig(string configName);
  134. /// <summary>
  135. /// 清空所有全局配置项。
  136. /// </summary>
  137. void RemoveAllConfigs();
  138. }
  139. }