Fungus 文档地址

首页 ·snozbot/fungus 维基 — Home · snozbot/fungus Wiki

简单入门：

【Unity 实用插件篇】 | 使用Fungus插件制作一个对话系统，简单好学易上手-腾讯云开发者社区-腾讯云

Fungus通信方式

Fungus 是一个基于 Unity 的叙事工具，它提供了强大的可视化编程功能，但有时你需要将 Fungus 与自定义的 C# 代码结合使用，以实现更复杂的游戏逻辑。以下是 Fungus 与代码通信的几种常见方式：

1. 通过 Message 通信

Fungus 的 Message 是一种事件机制，可以在代码中触发 Fungus 的 Block 执行。

步骤：

  1. 在 Fungus Flowchart 中创建一个 Block，并添加 Message 命令，设置 Message 名称（例如 "StartDialogue"）。
  2. 在 C# 脚本中调用 Flowchart.SendMessage 来触发该 Message。

示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
using UnityEngine;
using Fungus;

public class TriggerFungusMessage : MonoBehaviour
{
    public Flowchart flowchart;

    void Start()
    {
        // 触发 Fungus 中的 Message
        if (flowchart != null)
        {
            flowchart.SendMessage("StartDialogue");
        }
    }
}

2. 通过 Variable 通信

Fungus 的 Variable 可以存储数据，你可以在代码中读取或修改这些变量。

步骤：

  1. 在 Fungus Flowchart 中创建一个变量（例如 Integer 类型的 PlayerScore）。
  2. 在 C# 脚本中使用 Flowchart.SetVariable 和 Flowchart.GetVariable 来访问和修改变量。

示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
using UnityEngine;
using Fungus;

public class SetFungusVariable : MonoBehaviour
{
    public Flowchart flowchart;

    void Start()
    {
        if (flowchart != null)
        {
            // 设置 Fungus 变量
            flowchart.SetIntegerVariable("PlayerScore", 100);

            // 获取 Fungus 变量
            int score = flowchart.GetIntegerVariable("PlayerScore");
            Debug.Log("Player Score: " + score);
        }
    }
}

3. 通过 Custom Command 通信

如果你需要在 Fungus 中执行自定义的逻辑，可以创建自定义的 Fungus 命令。

步骤：

  1. 创建一个继承自 Fungus.Command 的 C# 脚本。
  2. 实现自定义逻辑。
  3. 在 Fungus Flowchart 中使用该命令。

示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
using UnityEngine;
using Fungus;

[CommandInfo("Custom", "Print Message", "Prints a custom message to the console")]
public class PrintMessageCommand : Command
{
    public string message = "Hello, Fungus!";

    public override void OnEnter()
    {
        Debug.Log(message);
        Continue(); // 继续执行下一个命令
    }
}

在 Fungus Flowchart 中，你可以找到 Print Message 命令并使用它。

4. 通过 Event Handler 通信

Fungus 提供了事件系统，你可以通过代码监听 Fungus 的事件。

示例：

监听 Fungus 的 BlockStart 事件。

示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
using UnityEngine;
using Fungus;

public class FungusEventListener : MonoBehaviour
{
    void OnEnable()
    {
        // 监听 Block 开始事件
        BlockSignals.OnBlockStart += OnBlockStart;
    }

    void OnDisable()
    {
        // 取消监听
        BlockSignals.OnBlockStart -= OnBlockStart;
    }

    void OnBlockStart(Block block)
    {
        Debug.Log("Block started: " + block.BlockName);
    }
}

5. 通过 Flowchart 方法调用

Fungus 的 Flowchart 组件提供了许多方法，可以直接在代码中调用。

常用方法：

  • ExecuteBlock(string blockName)：执行指定的 Block。
  • StopAllBlocks()：停止所有正在执行的 Block。
  • GetVariable<T>(string variableName)：获取指定变量。

示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
using UnityEngine;
using Fungus;

public class ControlFungusFlowchart : MonoBehaviour
{
    public Flowchart flowchart;

    void Start()
    {
        if (flowchart != null)
        {
            // 执行指定的 Block
            flowchart.ExecuteBlock("MyBlock");

            // 停止所有 Block
            flowchart.StopAllBlocks();
        }
    }
}

6. 通过 Fungus 调用外部代码

Fungus 的 Call Method 命令可以直接调用 C# 脚本中的方法。

步骤：

  1. 在 C# 脚本中定义一个公共方法。
  2. 在 Fungus Flowchart 中使用 Call Method 命令调用该方法。

示例代码：

1
2
3
4
5
6
7
8
9
using UnityEngine;

public class MyScript : MonoBehaviour
{
    public void MyMethod()
    {
        Debug.Log("MyMethod called from Fungus!");
    }
}

在 Fungus Flowchart 中：

  1. 添加 Call Method 命令。
  2. 选择 MyScript 组件。
  3. 选择 MyMethod 方法。

7. 通过 Fungus 的 Lua 脚本

Fungus 支持 Lua 脚本，你可以在 Lua 脚本中调用 C# 方法。

示例：

在 Lua 脚本中调用 C# 方法。

示例代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
using UnityEngine;
using Fungus;

public class LuaIntegration : MonoBehaviour
{
    public Flowchart flowchart;

    void Start()
    {
        if (flowchart != null)
        {
            // 注册 C# 方法到 Lua
            flowchart.ExecuteLua("myMethod = function() UnityEngine.Debug.Log('Hello from Lua!') end");

            // 调用 Lua 脚本
            flowchart.ExecuteLua("myMethod()");
        }
    }
}

总结

Fungus 提供了多种与代码通信的方式，包括：

  • Message：触发 Fungus Block。
  • Variable：读取和修改 Fungus 变量。
  • Custom Command：创建自定义命令。
  • Event Handler：监听 Fungus 事件。
  • Flowchart 方法调用：直接控制 Flowchart。
  • Call Method：在 Fungus 中调用外部代码。
  • Lua 脚本：通过 Lua 脚本与代码交互。

根据你的需求选择合适的方式，将 Fungus 与代码无缝结合，实现更复杂的游戏逻辑和叙事效果！

Fungus Command脚本扩展

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
using UnityEngine;
using Fungus;

namespace ZyScripts.FungusExtend	//这是我规范的命名空间，不重要
{
    /// <summary>
    /// Fungus自定义扩展
    /// 设置鼠标的显示/隐藏
    /// </summary>
    [CommandInfo("ZyScripts",
             "Set Mouse Cursor Visible",
             "设置鼠标的显示/隐藏")]
    public class SetMouseCursorVisible : Command
    {
        [Header("Cursor.visible的值")]
        [SerializeField] private BooleanData cursorVisible;

        #region Public members
            
        //--->GetSummary()方法和GetButtonColor()方法都可以没有，但是OnEnter()方法一定要有。方法体就是你要实现的功能，即鼠标光标的显示/隐藏    
        public override void OnEnter()
        {
            Cursor.visible = cursorVisible;	//设置鼠标光标
            
            
            //--->OnEnter()方法里一定要有Continue()，它意味着这一个功能模块执行完毕了，跳转至下一个功能模块。一般写在OnEnter()方法体的最后一行
            Continue();
        }
		
        //--->用于在Unity编辑器里直观地展示模块功能或结果 （获取概要）
        public override string GetSummary()
        {
            if (cursorVisible.Value)
                return "显示鼠标，Cursor.visible = " + cursorVisible.Value;
            else
                return "隐藏鼠标，Cursor.visible = " + cursorVisible.Value;
        }
        
		//--->设置功能模块的颜色，我设置的是深蓝色，这让我可以更直观地发现自己写的模块在什么位置
        public override Color GetButtonColor()
        {
            return new Color32(150, 182, 255, 255);
        }
        
          /// <summary>
        /// 主要用来实现面板里的连线
        /// </summary>
        public bool MayCallBlock(Block block){
            return block == whichBlock.block;
        }

        #endregion
    }
}


Unity 对话插件Fungus脚本扩展——基础（继承Command）_fungus动态生成对话-CSDN博客

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.Serialization;

namespace Fungus {
	[CommandInfo("Custom",
			 "Execute Reference Block",
			 "Receive an object of type Block Reference and execute it.")]
	public class executeReferenceBlock : Command, IBlockCaller
	{

		[Tooltip("the block")]
		[SerializeField] protected BlockReference whichBlock;	//用BlockReference的目的是为了在面板可以选择对应的Block

		public override void OnEnter(){
			if(whichBlock.block != null){
				whichBlock.Execute();
			}
			Continue();
		}
		/// <summary>
        /// 必要的实现
        /// </summary>
		public override void GetConnectedBlocks(ref List<Block> connectedBlocks)
        {
            if (whichBlock.block != null)
            {
                connectedBlocks.Add(whichBlock.block);
            }       
        }
		/// <summary>
        /// 主要用来实现面板里的连线
        /// </summary>
		public bool MayCallBlock(Block block){
            return block == whichBlock.block;
        }
	}
}

Unity插件Fungus自定义Command_fungus unity-CSDN博客