bevy_serde_lens

为bevy引擎提供闪电般快速、状态化、结构化和可读性序列化库。

功能

• 具有世界访问权限的状态化序列化和反序列化。
• 闪电般快速（与DynamicScene相比）。
• 将Entity、其Component及其子项视为单个serde对象。
• 将类似于Box<dyn T>的特例对象反序列化，作为typetag的替代方案。
• 极其轻量级和模块化。没有系统，没有插件。
• 支持使用熟悉语法的每种serde格式。
• 序列化Handle并提供通用数据归一化接口。
• 以安全的方式序列化存储的Entity。
• 无需反射。

入门指南

想象我们有一个典型的Character包。

首先我们推导出BevyObject

#[derive(Bundle, BevyObject)]
#[bevy_object(query)]
pub struct Character {
    pub transform: Transform,
    pub name: Name,
    pub position: Position,
    pub hp: Hp,
}

• #[bevy_object(查询)]

这表示我们正在序列化一个查询而不是层次结构树，这可以提高性能。

要序列化，我们只需这样做

serde_json::to_string(&world.serialize_lens::<Character>());

这将找到符合包的QueryFilter的所有实体并将它们序列化到数组中。

要反序列化，我们使用deserialize_scope

world.deserialize_scope(|| {
    // Returned object doesn't matter, data is stored in the world.
    let _ = serde_json::from_str::<InWorld<Character>>(&json_string);
})

此语句在世界上生成新的实体并将它们填充为反序列化的数据。

在加载新的之前，您可能想要删除当前实体，以删除序列化关联的所有实体的关联实体

// Despawn all character.
world.despawn_bound_objects::<Character>()

要批量保存多种类型的对象，使用batch!宏创建一个批处理序列化类型。

type SaveFile = batch!(
    Character, Monster,
    // Use `SerializeResource` to serialize a resource.
    SerializeResource<Terrain>,
);
world.save::<SaveFile>(serializer)
world.load::<SaveFile>(deserializer)
world.despawn_bound_objects::<SaveFile>()

这将在映射条目中保存每种类型

{
    "Character": [ 
        { .. },
        { .. },
        ..
    ],
    "Monster": [ .. ],
    "Terrain": ..
}

高级序列化

BevyObject不仅是对Bundle的克隆，我们支持附加类型。

• impl BevyObject：组件自动成为BevyObject，并且BevyObject可以包含多个其他BevyObject。
• Maybe<T> 可以用来表示一个项可能存在也可能不存在。
• DefaultInit 使用 FromWorld 初始化非序列化组件。
• Child<T> 在子组件中查找并序列化单个 BevyObject。
• ChildVec<T> 在子组件中查找并序列化多个 BevyObject。

有关详细信息，请参阅 BevyObject 继承宏。

// Note we cannot derive bundle anymore :(
// #[bevy_object(query)] also cannot be used due to children being serialized.
#[derive(BevyObject)]
#[bevy_object(rename = "character")]
pub struct Character {
    pub transform: Transform,
    pub name: Name,
    pub position: Position,
    pub hp: Hp,
    #[serde(default)]
    pub weapon: Maybe<Weapon>
    #[serde(skip)]
    pub cache: DefaultInit<Cache>,
    pub potions: ChildVec<Potion>
}

投影类型

该软件包为某些常见用例提供各种投影类型。

例如，要将 Handle 序列化为其字符串路径，可以使用如下 #[serde(with = "PathHandle")]

#[derive(Serialize, Deserialize)]
struct MySprite {
    #[serde(with = "PathHandle")]
    image: Handle<Image>
}

#[derive(Serialize, Deserialize)]
struct MySprite {
    image: PathHandle<Image>
}

world.register_typetag::<Box<dyn Animal>, Cat>()

#[derive(Serialize, Deserialize)]
struct MyComponent {
    #[serde(with = "TypeTagged")]
    weapon: Box<dyn Weapon>
}

world.register_deserialize_any(|s: &str| 
    Ok(Box::new(s.parse::<Cat>()
        .map_err(|e| e.to_string())?
    ) as Box<dyn Animal>)
)