mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-03-22 19:03:29 +08:00
fb14d7122c
- 将所有小写的命名空间导入更正为首字母大写格式 - 统一 GFramework 框架的命名空间引用规范 - 修复 core、ecs、godot 等模块的命名空间导入错误 - 标准化文档示例代码中的 using 语句格式 - 确保所有文档中的命名空间引用保持一致性 - 更新 global using 语句以匹配正确的命名空间格式
82 lines
2.8 KiB
C#
82 lines
2.8 KiB
C#
namespace GFramework.Core.Abstractions.State;
|
||
|
||
/// <summary>
|
||
/// 状态机接口，用于管理状态的注册、切换和验证
|
||
/// 支持同步和异步状态操作
|
||
/// </summary>
|
||
public interface IStateMachine
|
||
{
|
||
/// <summary>
|
||
/// 获取当前激活的状态
|
||
/// </summary>
|
||
IState? Current { get; }
|
||
|
||
/// <summary>
|
||
/// 注册一个状态到状态机中
|
||
/// </summary>
|
||
/// <param name="state">要注册的状态实例</param>
|
||
IStateMachine Register(IState state);
|
||
|
||
/// <summary>
|
||
/// 异步从状态机中注销指定类型的状态
|
||
/// </summary>
|
||
/// <typeparam name="T">要注销的状态类型，必须实现IState接口</typeparam>
|
||
Task<IStateMachine> UnregisterAsync<T>() where T : IState;
|
||
|
||
/// <summary>
|
||
/// 异步检查是否可以切换到指定类型的状态
|
||
/// </summary>
|
||
/// <typeparam name="T">目标状态类型，必须实现IState接口</typeparam>
|
||
/// <returns>如果可以切换则返回true，否则返回false</returns>
|
||
Task<bool> CanChangeToAsync<T>() where T : IState;
|
||
|
||
/// <summary>
|
||
/// 异步切换到指定类型的状态
|
||
/// </summary>
|
||
/// <typeparam name="T">要切换到的状态类型，必须实现IState接口</typeparam>
|
||
/// <returns>如果成功切换则返回true，否则返回false</returns>
|
||
Task<bool> ChangeToAsync<T>() where T : IState;
|
||
|
||
/// <summary>
|
||
/// 检查指定类型的状态是否已注册
|
||
/// </summary>
|
||
/// <typeparam name="T">要检查的状态类型</typeparam>
|
||
/// <returns>如果状态已注册则返回true，否则返回false</returns>
|
||
bool IsRegistered<T>() where T : IState;
|
||
|
||
/// <summary>
|
||
/// 获取指定类型的已注册状态实例
|
||
/// </summary>
|
||
/// <typeparam name="T">要获取的状态类型</typeparam>
|
||
/// <returns>如果状态存在则返回对应实例，否则返回null</returns>
|
||
T? GetState<T>() where T : class, IState;
|
||
|
||
/// <summary>
|
||
/// 获取所有已注册状态的类型集合
|
||
/// </summary>
|
||
/// <returns>包含所有已注册状态类型的枚举器</returns>
|
||
IEnumerable<Type> GetRegisteredStateTypes();
|
||
|
||
/// <summary>
|
||
/// 获取上一个状态
|
||
/// </summary>
|
||
/// <returns>如果历史记录存在则返回上一个状态，否则返回null</returns>
|
||
IState? GetPreviousState();
|
||
|
||
/// <summary>
|
||
/// 获取状态历史记录
|
||
/// </summary>
|
||
/// <returns>状态历史记录的只读副本</returns>
|
||
IReadOnlyList<IState> GetStateHistory();
|
||
|
||
/// <summary>
|
||
/// 异步回退到上一个状态
|
||
/// </summary>
|
||
/// <returns>如果成功回退则返回true，否则返回false</returns>
|
||
Task<bool> GoBackAsync();
|
||
|
||
/// <summary>
|
||
/// 清空状态历史记录
|
||
/// </summary>
|
||
void ClearHistory();
|
||
} |