Unity SKFramework框架（三）、FSM 有限状态机

目录

一、State 状态

1.核心属性

2.核心事件

二、StateMachine 状态机

1.核心属性

2.Create 创建状态机

3.Get 获取状态机

4.Destroy 销毁状态机

5.核心行为

(1).添加状态

(2).移除状态

(3).切换状态

(4).获取状态

(5).设置切换条件

三、编码示例

1.Simple

2.链式

一、State 状态 1.核心属性

/// 
/// 状态名称
/// 
public string Name { get; set; }

2.核心事件

        OnInitialization 状态初始化事件

        OnEnter 状态进入事件

        OnStay 状态停留事件

        OnExit 状态退出事件

        OnTermination 状态终止事件

public class ExampleState : State
{
    public override void OnInitialization()
    {
        Debug.Log(string.Format("{0}状态初始化", Name));
    }
    public override void OnEnter()
    {
        Debug.Log(string.Format("{0}状态进入", Name));
    }
    public override void OnStay()
    {
        Debug.Log(string.Format("{0}状态停留", Name));
    }
    public override void OnExit()
    {
        Debug.Log(string.Format("{0}状态退出", Name));
    }
    public override void OnTermination()
    {
        Debug.Log(string.Format("{0}状态终止", Name));
    }
}

二、StateMachine 状态机 1.核心属性

/// 
/// 状态机名称
/// 
public string Name { get; set; }
/// 
/// 当前状态
/// 
public IState CurrentState { get; protected set; }

2.Create 创建状态机

using UnityEngine;
using SK.Framework;

public class Example : MonoBehaviour
{
    private void Start()
    {
        var machine = StateMachine.Create("Example");
    }
}   

传入string类型参数，表示状态机的命名，通过名称可以获取、销毁状态机。

3.Get 获取状态机

using UnityEngine;
using SK.Framework;

public class Example : MonoBehaviour
{
    private void Start()
    {
        var machine = StateMachine.Get("Example");
    }
}   

4.Destroy 销毁状态机

private void OnDestroy()
{
    StateMachine.Destroy("Example");
}

5.核心行为 (1).添加状态

/// 
/// 添加状态
/// 
/// 状态
/// 添加成功返回true 否则返回false
public bool Add(IState state)
/// 
/// 添加状态
/// 
/// 状态类型
/// 状态命名
/// 添加成功返回true 否则返回false
public bool Add(string stateName = null) where T : IState, new()

除此之外，可以通过Build构建状态实现添加，用于链式编程：

/// 
/// 构建状态
/// 
/// 状态类型
/// 状态名称
/// 状态构建器
public StateBuilder Build(string stateName = null) where T : State, new()

(2).移除状态

/// 
/// 移除状态
/// 
/// 状态
/// 移除成功返回true 否则返回false
public bool Remove(IState state)
/// 
/// 移除状态
/// 
/// 状态名称
/// 移除成功返回true 否则返回false
public bool Remove(string stateName)
/// 
/// 移除状态
/// 
/// 状态类型
/// 移除成返回true 否则返回false
public bool Remove() where T : IState

(3).切换状态

/// 
/// 切换状态
/// 
/// 状态
/// 切换成功返回true 否则返回false
public bool Switch(IState state)
/// 
/// 切换状态
/// 
/// 状态名称
/// 切换成功返回true 否则返回false
public bool Switch(string stateName)
/// 
/// 切换状态
/// 
/// 状态类型
/// 切换成返回true 否则返回false
public bool Switch() where T : IState
/// 
/// 切换至下一状态
/// 
public void Switch2Next()
/// 
/// 切换至上一状态
/// 
public void Switch2Last()
/// 
/// 切换至空状态（退出当前状态）
/// 
public void Switch2Null()

(4).获取状态

/// 
/// 获取状态
/// 
/// 状态类型
/// 状态名称
/// 状态
public T GetState(string stateName) where T : IState
/// 
/// 获取状态
/// 
/// 状态类型
/// 状态
public T GetState() where T : IState

(5).设置切换条件

/// 
/// 设置状态切换条件
/// 
/// 切换条件
/// 目标状态名称
/// 状态机
public StateMachine SwitchWhen(Func predicate, string targetStateName)
/// 
/// 设置状态切换条件
/// 
/// 切换条件
/// 源状态名称
/// 目标状态名称
/// 
public StateMachine SwitchWhen(Func predicate, string sourceStateName, string targetStateName)

三、编码示例 1.Simple

using UnityEngine;
using SK.Framework;

public class Example : MonoBehaviour
{
    public class ExampleState : State
    {
        public override void OnInitialization()
        {
            Debug.Log(string.Format("{0}状态初始化", Name));
        }
        public override void OnEnter()
        {
            Debug.Log(string.Format("{0}状态进入", Name));
        }
        public override void OnStay()
        {
            Debug.Log(string.Format("{0}状态停留", Name));
        }
        public override void OnExit()
        {
            Debug.Log(string.Format("{0}状态退出", Name));
        }
        public override void OnTermination()
        {
            Debug.Log(string.Format("{0}状态终止", Name));
        }
    }

    private void Start()
    {
        var machine = StateMachine.Create("示例状态机");
        machine.Add(new ExampleState() { Name = "State1" });
        machine.Add("State2");
        machine.Add("State3");
        machine.Switch("State2");
        machine.Switch2Next();
        machine.Switch2Last();
        machine.Switch2Null();
        machine.SwitchWhen(() => Input.GetKeyDown(KeyCode.Alpha1), "State1");
        machine.SwitchWhen(() => Input.GetKeyDown(KeyCode.Alpha2), "State2");
        machine.SwitchWhen(() => Input.GetKeyDown(KeyCode.Alpha3), "State3");
    }
}   

2.链式

using UnityEngine;
using SK.Framework;
 
public class Example: MonoBehaviour
{
    public class TestState : State
    {
        public string stringValue;
    }
 
    private void Start()
    {
        //创建状态机
        var machine = StateMachine.Create("示例状态机")
            //构建状态一
            .Build("状态一")
                //设置状态一初始化事件
                .OnInitialization(state => state.stringValue = "A")
                //设置状态一进入事件
                .OnEnter(state => Debug.Log("进入状态一"))
                //设置状态一停留事件
                .OnStay(state => Debug.Log("状态一"))
                //设置状态一推出事件
                .OnExit(state => Debug.Log("退出状态一"))
                //设置状态一销毁事件
                .OnTermination(state => state.stringValue = null)
            //状态一构建完成
            .Complete()
            //构建状态二
            .Build("状态二")
                //设置状态二进入事件
                .OnEnter(state => Debug.Log("进入状态二"))
                //设置状态二停留事件
                .OnStay(state => Debug.Log("状态二"))
                //设置状态二退出事件
                .OnExit((state => Debug.Log("退出状态二")))
            //状态二构建完成
            .Complete()
            //构建状态三
            .Build("状态三")
                //设置状态三进入事件
                .OnEnter(state => Debug.Log("进入状态三"))
                //设置状态三停留事件
                .OnStay(state => Debug.Log("状态三"))
                //设置状态三退出事件
                .OnExit((state => Debug.Log("退出状态三")))
            //状态三构建完成
            .Complete()
            //添加状态切换条件 当按下快捷键1时 切换至状态一
            .SwitchWhen(() => Input.GetKeyDown(KeyCode.Alpha1), "状态一")
            //添加状态切换条件 当按下快捷键2时 切换至状态二
            .SwitchWhen(() => Input.GetKeyDown(KeyCode.Alpha2), "状态二")
            //添加状态切换条件 当按下快捷键3时 切换至状态三
            .SwitchWhen(() => Input.GetKeyDown(KeyCode.Alpha3), "状态三")
            //为状态一至状态二添加切换条件：若当前状态为状态一时 按下快捷键4 切换至状态二
            .SwitchWhen(() => Input.GetKeyDown(KeyCode.Alpha4), "状态一", "状态二");
 
        //切换到指定状态
        machine.Switch("状态一");
        //切换到下一状态
        machine.Switch2Next();
        //切换到上一状态
        machine.Switch2Last();
    }
}