数据结点 | Game Framework

将任意类型的数据以树状结构的形式进行保存，用于管理游戏运行时的各种数据。

常规用法

获取数据结点组件

DataNodeComponent dataNodeComponent = GameEntry.GetComponent<DataNodeComponent>();

1	DataNodeComponent dataNodeComponent = GameEntry.GetComponent<DataNodeComponent>();

获取根数据结点

IDataNode root = dataNodeComponent.Root;

1	IDataNode root = dataNodeComponent.Root;

移除所有数据结点

dataNodeComponent.Clear();

1	dataNodeComponent.Clear();

数据结点相关操作

IDataNode node = /* 某个数据结点 */;

// 获取数据结点的名字
string nodeName = node.Name;

// 获取数据结点的完整名称
string nodeFullName = node.FullName;

// 获取数据结点的父数据结点
IDataNode nodeParent = node.Parent;

// 获取数据结点的子数据结点数量
int nodeChildCount = node.ChildCount;

// 获取数据结点的数据
Variable nodeValue = node.GetData();

// 设置数据结点的数据
node.SetData(/* 此示例忽略数据参数 */);

// 根据索引检查是否存在子数据结点
bool hasChildByIndex = node.HasChild(0);

// 根据名称检查是否存在子数据结点
bool hasChildByName = node.HasChild("ChildName");

// 根据索引获取子数据结点，若不存在则返回 null
IDataNode nodeChildByIndex = node.GetChild(0);

// 根据名称获取子数据结点，若不存在则返回 null
IDataNode nodeChildByName = node.GetChild("ChildName");

// 根据名称获取子数据结点，若不存在则创建并返回
IDataNode nodeNewChildByName = node.GetOrAddChild("ChildName");

// 根据索引移除子数据结点
node.RemoveChild(0);

// 根据名称移除子数据结点
node.RemoveChild("ChildName");

// 获取全部子数据结点，返回数组结果，会有额外内存分配
IDataNode[] nodeChildren = node.GetAllChild();

// 获取全部子数据结点，可重复使用预先分配好的 List 存储结果，避免内存分配
List<IDataNode> nodeChildrenResult = new List<IDataNode>();
node.GetAllChild(nodeChildrenResult);

// 移除当前数据结点的数据和所有子数据结点
node.Clear();

IDataNode node = /* 某个数据结点 */;

// 获取数据结点的名字

string nodeName = node.Name;

// 获取数据结点的完整名称

string nodeFullName = node.FullName;

// 获取数据结点的父数据结点

IDataNode nodeParent = node.Parent;

// 获取数据结点的子数据结点数量

int nodeChildCount = node.ChildCount;

// 获取数据结点的数据

Variable nodeValue = node.GetData();

// 设置数据结点的数据

node.SetData(/* 此示例忽略数据参数 */);

// 根据索引检查是否存在子数据结点

bool hasChildByIndex = node.HasChild(0);

// 根据名称检查是否存在子数据结点

bool hasChildByName = node.HasChild("ChildName");

// 根据索引获取子数据结点，若不存在则返回 null

IDataNode nodeChildByIndex = node.GetChild(0);

// 根据名称获取子数据结点，若不存在则返回 null

IDataNode nodeChildByName = node.GetChild("ChildName");

// 根据名称获取子数据结点，若不存在则创建并返回

IDataNode nodeNewChildByName = node.GetOrAddChild("ChildName");

// 根据索引移除子数据结点

node.RemoveChild(0);

// 根据名称移除子数据结点

node.RemoveChild("ChildName");

// 获取全部子数据结点，返回数组结果，会有额外内存分配

IDataNode[] nodeChildren = node.GetAllChild();

// 获取全部子数据结点，可重复使用预先分配好的 List 存储结果，避免内存分配

List<IDataNode> nodeChildrenResult = new List<IDataNode>();

node.GetAllChild(nodeChildrenResult);

// 移除当前数据结点的数据和所有子数据结点

node.Clear();

通过绝对路径获取或设置数据

VarString varPlayerName = "Ellan";

// 使用绝对路径设置数据结点的数据
dataNodeComponent.SetData("Player.Name", varPlayerName);

// 可以使用绝对路径获取数据结点的数据变量
Variable playerNameVariable = dataNodeComponent.GetData("Player.Name");

// 也可以使用绝对路径获取数据结点的数据值
string playerNameValue = dataNodeComponent.GetData<VarString>("Player.Name");

Log.Info("玩家姓名是 '{0}' '{1}'", playerNameVariable.ToString(), playerNameValue);

VarString varPlayerName = "Ellan";

// 使用绝对路径设置数据结点的数据

dataNodeComponent.SetData("Player.Name", varPlayerName);

// 可以使用绝对路径获取数据结点的数据变量

Variable playerNameVariable = dataNodeComponent.GetData("Player.Name");

// 也可以使用绝对路径获取数据结点的数据值

string playerNameValue = dataNodeComponent.GetData<VarString>("Player.Name");

Log.Info("玩家姓名是 '{0}' '{1}'", playerNameVariable.ToString(), playerNameValue);

通过参照某个数据结点和相对路径获取或设置数据

// 获取某个数据结点
IDataNode playerNode = dataNodeComponent.GetNode("Player");

// 使用相对路径设置数据结点的数据
dataNodeComponent.SetData<VarInt>("Level", 99, playerNode);

// 使用相对路径获取数据结点的数据
// 等价于 dataNodeComponent.GetData("Player.Level")
Variable playerLevelVariable = dataNodeComponent.GetData("Level", playerNode);

Log.Info("玩家等级是 '{0}'", playerLevelVariable.ToString());

// 获取某个数据结点

IDataNode playerNode = dataNodeComponent.GetNode("Player");

// 使用相对路径设置数据结点的数据

dataNodeComponent.SetData<VarInt>("Level", 99, playerNode);

// 使用相对路径获取数据结点的数据

// 等价于 dataNodeComponent.GetData("Player.Level")

Variable playerLevelVariable = dataNodeComponent.GetData("Level", playerNode);

Log.Info("玩家等级是 '{0}'", playerLevelVariable.ToString());

内置变量类

数据结点上的数据仅允许使用从 Variable 类派生的对象，当前包含了以下内置变量类型。

自定义变量类

使用者可以自定义所需的变量类型。

例如，有一个用于记录构建信息的 BuildInfo 类。

/// <summary>
/// 构建信息类。
/// </summary>
[Serializable]
public class BuildInfo
{
    public string GameVersion = string.Empty;
    public int InternalVersion = 0;
}

/// <summary>

/// 构建信息类。

/// </summary>

[Serializable]

public class BuildInfo

{

public string GameVersion = string.Empty;

public int InternalVersion = 0;

}

若想把此类型的值用于数据结点中，需要定义相应的变量类 VarBuildInfo 后，即可使用了。

/// <summary>
/// 构建信息变量类。
/// </summary>
public class VarBuildInfo : Variable<BuildInfo>
{
    /// <summary>
    /// 初始化构建信息变量类的新实例。
    /// </summary>
    public VarBuildInfo()
    {
    }

    /// <summary>
    /// 初始化构建信息变量类的新实例。
    /// </summary>
    /// <param name="value">值。</param>
    public VarBuildInfo(BuildInfo value)
        : base(value)
    {
    }

    /// <summary>
    /// 从构建信息类到构建信息变量类的隐式转换。
    /// </summary>
    /// <param name="value">值。</param>
    public static implicit operator VarBuildInfo(BuildInfo value)
    {
        return new VarBuildInfo(value);
    }

    /// <summary>
    /// 从构建信息变量类到构建信息类的隐式转换。
    /// </summary>
    /// <param name="value">值。</param>
    public static implicit operator BuildInfo(VarBuildInfo value)
    {
        return value.Value;
    }
}

/// <summary>

/// 构建信息变量类。

/// </summary>

public class VarBuildInfo : Variable<BuildInfo>

{

/// <summary>

/// 初始化构建信息变量类的新实例。

/// </summary>

public VarBuildInfo()

{

}

/// <summary>

/// 初始化构建信息变量类的新实例。

/// </summary>

/// <param name="value">值。</param>

public VarBuildInfo(BuildInfo value)

: base(value)

{

}

/// <summary>

/// 从构建信息类到构建信息变量类的隐式转换。

/// </summary>

/// <param name="value">值。</param>

public static implicit operator VarBuildInfo(BuildInfo value)

{

return new VarBuildInfo(value);

}

/// <summary>

/// 从构建信息变量类到构建信息类的隐式转换。

/// </summary>

/// <param name="value">值。</param>

public static implicit operator BuildInfo(VarBuildInfo value)

{

return value.Value;

}

参考手册

最佳实践

暂无。

常见问题

暂无。