IFsm.cs 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  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 System;
  8. using System.Collections.Generic;
  9. namespace GameFramework.Fsm
  10. {
  11. /// <summary>
  12. /// 有限状态机接口。
  13. /// </summary>
  14. /// <typeparam name="T">有限状态机持有者类型。</typeparam>
  15. public interface IFsm<T> where T : class
  16. {
  17. /// <summary>
  18. /// 获取有限状态机名称。
  19. /// </summary>
  20. string Name
  21. {
  22. get;
  23. }
  24. /// <summary>
  25. /// 获取有限状态机完整名称。
  26. /// </summary>
  27. string FullName
  28. {
  29. get;
  30. }
  31. /// <summary>
  32. /// 获取有限状态机持有者。
  33. /// </summary>
  34. T Owner
  35. {
  36. get;
  37. }
  38. /// <summary>
  39. /// 获取有限状态机中状态的数量。
  40. /// </summary>
  41. int FsmStateCount
  42. {
  43. get;
  44. }
  45. /// <summary>
  46. /// 获取有限状态机是否正在运行。
  47. /// </summary>
  48. bool IsRunning
  49. {
  50. get;
  51. }
  52. /// <summary>
  53. /// 获取有限状态机是否被销毁。
  54. /// </summary>
  55. bool IsDestroyed
  56. {
  57. get;
  58. }
  59. /// <summary>
  60. /// 获取当前有限状态机状态。
  61. /// </summary>
  62. FsmState<T> CurrentState
  63. {
  64. get;
  65. }
  66. /// <summary>
  67. /// 获取当前有限状态机状态持续时间。
  68. /// </summary>
  69. float CurrentStateTime
  70. {
  71. get;
  72. }
  73. /// <summary>
  74. /// 开始有限状态机。
  75. /// </summary>
  76. /// <typeparam name="TState">要开始的有限状态机状态类型。</typeparam>
  77. void Start<TState>() where TState : FsmState<T>;
  78. /// <summary>
  79. /// 开始有限状态机。
  80. /// </summary>
  81. /// <param name="stateType">要开始的有限状态机状态类型。</param>
  82. void Start(Type stateType);
  83. /// <summary>
  84. /// 是否存在有限状态机状态。
  85. /// </summary>
  86. /// <typeparam name="TState">要检查的有限状态机状态类型。</typeparam>
  87. /// <returns>是否存在有限状态机状态。</returns>
  88. bool HasState<TState>() where TState : FsmState<T>;
  89. /// <summary>
  90. /// 是否存在有限状态机状态。
  91. /// </summary>
  92. /// <param name="stateType">要检查的有限状态机状态类型。</param>
  93. /// <returns>是否存在有限状态机状态。</returns>
  94. bool HasState(Type stateType);
  95. /// <summary>
  96. /// 获取有限状态机状态。
  97. /// </summary>
  98. /// <typeparam name="TState">要获取的有限状态机状态类型。</typeparam>
  99. /// <returns>要获取的有限状态机状态。</returns>
  100. TState GetState<TState>() where TState : FsmState<T>;
  101. /// <summary>
  102. /// 获取有限状态机状态。
  103. /// </summary>
  104. /// <param name="stateType">要获取的有限状态机状态类型。</param>
  105. /// <returns>要获取的有限状态机状态。</returns>
  106. FsmState<T> GetState(Type stateType);
  107. /// <summary>
  108. /// 获取有限状态机的所有状态。
  109. /// </summary>
  110. /// <returns>有限状态机的所有状态。</returns>
  111. FsmState<T>[] GetAllStates();
  112. /// <summary>
  113. /// 获取有限状态机的所有状态。
  114. /// </summary>
  115. /// <param name="results">有限状态机的所有状态。</param>
  116. void GetAllStates(List<FsmState<T>> results);
  117. /// <summary>
  118. /// 是否存在有限状态机数据。
  119. /// </summary>
  120. /// <param name="name">有限状态机数据名称。</param>
  121. /// <returns>有限状态机数据是否存在。</returns>
  122. bool HasData(string name);
  123. /// <summary>
  124. /// 获取有限状态机数据。
  125. /// </summary>
  126. /// <typeparam name="TData">要获取的有限状态机数据的类型。</typeparam>
  127. /// <param name="name">有限状态机数据名称。</param>
  128. /// <returns>要获取的有限状态机数据。</returns>
  129. TData GetData<TData>(string name) where TData : Variable;
  130. /// <summary>
  131. /// 获取有限状态机数据。
  132. /// </summary>
  133. /// <param name="name">有限状态机数据名称。</param>
  134. /// <returns>要获取的有限状态机数据。</returns>
  135. Variable GetData(string name);
  136. /// <summary>
  137. /// 设置有限状态机数据。
  138. /// </summary>
  139. /// <typeparam name="TData">要设置的有限状态机数据的类型。</typeparam>
  140. /// <param name="name">有限状态机数据名称。</param>
  141. /// <param name="data">要设置的有限状态机数据。</param>
  142. void SetData<TData>(string name, TData data) where TData : Variable;
  143. /// <summary>
  144. /// 设置有限状态机数据。
  145. /// </summary>
  146. /// <param name="name">有限状态机数据名称。</param>
  147. /// <param name="data">要设置的有限状态机数据。</param>
  148. void SetData(string name, Variable data);
  149. /// <summary>
  150. /// 移除有限状态机数据。
  151. /// </summary>
  152. /// <param name="name">有限状态机数据名称。</param>
  153. /// <returns>是否移除有限状态机数据成功。</returns>
  154. bool RemoveData(string name);
  155. }
  156. }