图1 基于元信息的编辑器和运行时端的交互

在运行时端，也即游戏代码端，通过注册（C#通过标记Attribute的方式）并导出供行为树引擎和编辑器使用的XML元信息。运行时端主要是由程序员编写Agent的子类及其属性和方法，然后调用相关接口将这些元信息导出，就可以在编辑器中对这些元信息进行使用。

在编辑器中也可以创建和编辑元信息。在项目开始初期，也就是程序员还没把代码写出来之前，策划就可以自己手动的创建一些Agent子类、属性和方法等元信息。这样可以加速游戏原型的创建，也就是策划不用等程序员，就可以进行游戏原型的编辑。

整个工作流程主要分为以下几个步骤：

1 注册元信息

C#中编写的游戏类从behaviac.Agent派生，并通过相关的Attribute来标记元信息：

• 类：TypeMetaInfo
• 成员属性：MemberMetaInfo
• 成员方法：MethodMetaInfo

这3个类都可以接受诸如显示名字，描述等更多参数。详细请参考代码。

如下代码样例所示：

[behaviac.TypeMetaInfo()]
public class AgentNodeTest : behaviac.Agent
{
    [behaviac.MemberMetaInfo()]
    public int testVar_0 = -1;

    [behaviac.MemberMetaInfo("testVar_1", "testVar_1 property", 100)]
    public int testVar_1 = -1;

    [behaviac.MemberMetaInfo()]
    public float testVar_2 = -1.0f;

    [behaviac.MemberMetaInfo()]
    public int waiting_timeout_interval = 0;

    [behaviac.MemberMetaInfo()]
    public string testVar_str_0 = string.Empty;

    public bool m_bCanSee = false;

    [behaviac.MethodMetaInfo()]
    public void setEventVarInt(int var) {
        event_test_var_int = var;
    }

    [behaviac.MethodMetaInfo()]
    public void setEventVarBool(bool var) {
        event_test_var_bool = var;
    }
}

2 导出元信息

由于C#代码中已经包含了各种Attribute来描述元信息，因而导出相比C++要简单：

• Agent子类的实例通过Agent.RegisterInstanceName<***>(…)来进行注册。
• 调用Workspace.Instance.FilePath设置元信息文件导出的位置。
• 调用Workspace.Instance.ExportMetas(…)导出元信息文件。

如下代码样例所示：

public bool Init ()
{
    if (ms_fileSystem == null)
    {
        ms_fileSystem = new BehaviacFileManager();
    }

    //< write log file
    behaviac.Config.IsLogging = true;
    //behaviac.Config.IsSocketing = false;

    behaviac.Workspace.Instance.FilePath = this.WorkspaceExportPath;
    behaviac.Workspace.Instance.FileFormat = behaviac.Workspace.EFileFormat.EFF_xml;

    //register names
    behaviac.Agent.RegisterInstanceName<GameLevelCommon>("GameLevel");
    behaviac.Workspace.Instance.ExportMetas("behaviac/workspace/xmlmeta/BattleCityMeta.xml");

    behaviac.Debug.Log("Behaviac meta data export over.");
    behaviac.Agent.SetIdMask(0xffffffff);

    return true;
}

public void Uninit()
{
    behaviac.Workspace.Instance.Cleanup();
}

更多细节可以参考behaviac组件C#源码中附带的integration/BattleCityDemo工程的BehaviacSystem.cs文件。

• 点击上图中右侧的“…”设置按钮，在弹出的“C#导出设置”对话框中设置导出文件所在的位置，如图2所示：

• 回到“导出行为树”对话框，点击“导出”按钮，开始导出C#文件。在指定的导出位置（默认为当前工作区的导出路径）会自动生成一个名为behaviac_generated的文件夹，里面生成了behaviors和types两个子文件夹，如图3所示：
• behaviors文件夹含有generated_behaviors.cs及其他单个的行为树.cs文件（如果没有勾选“导出统一文件？”，则对每一棵行为树都会生成独立的.cs文件）。
• types文件夹中含有agentproperties.cs（为Agent类自定义的属性和方法，会扩展在该文件中）、customizedtypes.cs（自定义的枚举和结构体类型，会生成在这个文件中）以及其他的Agent子类的文件（这些文件是为添加的Agent子类自动生成的.cs文件，需要程序员补充代码进一步实现这些Agent子类的逻辑），这些自动生成的文件都需要包含到自己的游戏项目中。

• 注意：这些自动生成的文件都需要包含到自己的游戏项目中，一起参与整个项目代码的编译和构建。
• 在项目中包含了这些自动生成的.cs文件后，就可以与前面提及的导出和使用XML/BSON行为树一样的接口和方式加载使用这些文件，只是需要将文件格式改为EFF_cs：

behaviac.Workspace.Instance.FileFormat = behaviac.Workspace.EFileFormat.EF

导出和使用XML/BSON行为树

• 在编辑器中导出整个工作区文件，在“导出行为树”对话框中，勾选“Xml Behavior Exporter”或“Bson Behavior Exporter”，如下图所示：

• 导出行为树文件结束后，回到运行时（游戏）代码端，按以下步骤使用行为树文件：
  • 在游戏的初始化函数中，添加Agent::Register<***>()注册类信息到引擎库中。
  • 调用Workspace::SetFilePath(…)函数，设置行为树文件的加载路径，也即编辑器导出行为树文件所在的目录。
  • 调用Workspace::SetFileFormat(…)函数，设置加载行为树的文件格式，如果不调用则默认加载EFF_xml格式。
  • 通过调用Agent的接口btload(…)加载所需的行为树文件。
  • 通过调用Agent的接口btsetcurrent(…)设置当前准备执行的行为树文件。
  • 行为树的更新执行流程请参考更新流程。
  • 在游戏的释放函数里面，添加Agent::Unregister<***>()用于释放类型的注册信息。

如下代码样例所示：

bool InitBehavic(behaviac::Workspace::EFileFormat ff)
{
    behaviac::Config::SetSocketBlocking(false);
    behaviac::Config::SetSocketPort(8081);

    behaviac::Agent::Register<CBTPlayer>();

    behaviac::Workspace::GetInstance()->SetFilePath("../test/demo_running/behaviac/exported");
    behaviac::Workspace::GetInstance()->SetFileFormat(ff);

    behaviac::Workspace::GetInstance()->ExportMetas("../test/demo_running/behaviac/demo_running.xml");

    //behaviac::Agent::SetIdMask(kIdMask_Wolrd | kIdMask_Opponent);
    behaviac::Workspace::GetInstance()->SetDeltaFrames(1);

    return true;
}

bool InitPlayer(const char* pszTreeName)
{
    g_player = behaviac::Agent::Create<CBTPlayer>();

    bool bRet = false;
    bRet = g_player->btload(pszTreeName);
    assert(bRet);

    g_player->btsetcurrent(pszTreeName);

    return bRet;
}

void CleanupPlayer()
{
    behaviac::Agent::Destroy(g_player);
}

void CleanupBehaviac()
{
    behaviac::Agent::UnRegister<CBTPlayer>();

    behaviac::Workspace::GetInstance()->Cleanup();
}

总之，一棵行为树的加载到执行，关键的就是前面提及的三个接口：btload()、btsetcurrent()和btexec()。

更多细节可以参考behaviac组件C++源码中附带的test/demo_running工程的demo_running.cpp文件。

类似的，对于C#版的运行时端，采用如下代码样例加载使用刚才导出的行为树：

public bool Init ()
{
    if (ms_fileSystem == null)
    {
        ms_fileSystem = new BehaviacFileManager();
    }

    //< write log file
    behaviac.Config.IsLogging = true;
    //behaviac.Config.IsSocketing = false;

    behaviac.Workspace.Instance.FilePath = this.WorkspaceExportPath;
    behaviac.Workspace.Instance.FileFormat = behaviac.Workspace.EFileFormat.EFF_xml;

    //register names
    behaviac.Agent.RegisterInstanceName<GameLevelCommon>("GameLevel");
    behaviac.Workspace.Instance.ExportMetas("behaviac/workspace/xmlmeta/BattleCityMeta.xml");

    behaviac.Debug.Log("Behaviac meta data export over.");
    behaviac.Agent.SetIdMask(0xffffffff);

    return true;
}

public void Uninit()
{
    behaviac.Workspace.Instance.Cleanup();
}

// 加载所需的行为树文件
if(behaviorTree.Length > 0)
{
    btloadResult = agent.btload(behaviorTree, true);
    if(btloadResult)
        agent.btsetcurrent(behaviorTree);
    else
        Debug.LogError("Behavior tree data load failed! " + behaviorTree);
}

更多细节可以参考behaviac组件C#源码中附带的integration/BattleCityDemo工程的BehaviacSystem.cs文件。

• 调用DebugUpdate()函数来更新一些连调和热加载相关的功能。
• 根据m_bExecAgents来判断是否需要执行所有Agent实例的btexec()函数，可以通过接口Workspace::SetIsExecAgents(bool bExecAgents)对m_bExecAgents进行设置。

具体执行逻辑如下代码所示：

void Workspace::DebugUpdate()
{
    this->LogFrames();
    this->HandleRequests();

    if (this->GetAutoHotReload())
    {
        this->HotReload();
    }
}

void Workspace::Update()
{
    this->DebugUpdate();

    if (this->m_bExecAgents)
    {
        int contextId = -1;

        Context::execAgents(contextId);
    }
}

对于C++版，行为树的执行可以调用behaviac::Workspace::GetInstance()->Update()来执行所有Agent实例的行为树，也可以单独调用Agent的接口btexec()来执行单个实例的行为树。

其中，Workspace::Update()会遍历所有的Agent实例并依次执行btexec()，但在自己的游戏项目中，可能在一帧中需要对某些Agent多次调用btexec()，而另一些Agent只需调用一次，这时候就需要单独调用Agent::btexec()，而不是统一调用Workspace::Update()。

Workspace::Update()在调用Agent::btexec()之前，会检查Agent::IsActive()是否为true，如果为false，那么btexec()就不会被调用。

此外，为了支持连调和热加载，请务必保证在自己游戏的更新函数中调用了DebugUpdate()函数。如果已经调用了behaviac::Workspace::GetInstance()->Update()，那么就不需要再单独调用DebugUpdate()。

上述示例代码虽然是C++，但对于C#，也都是同名的。

特别注意：对于C#版，behaviac.Workspace.IsExecAgents默认设为false。

• 如果将behaviac.Workspace.IsExecAgents设为true，使用behaviac.Workspace.Instance.Update()集中进行更新，Agent自己的更新就不需要调用btexec()了。
• 如果将behaviac.Workspace.IsExecAgents设为false，则不使用behaviac.Workspace.Instance.Update()集中进行更新，Agent自己的更新就需要调用btexec()了。