Module bevy_proto_backend::schematics

Schematic types used to build prototypes.

A Schematic is the basic building-block for prototypes. At its core, it represents some change in the world.

Normally, schematics are used to modify a single entity, often inserting a component or bundle. However, they can do any number of operations. They can modify existing components, insert resources, load assets, and so on.

Deserialization

Schematics are deserialized into a DynamicSchematic object. This is used to store type-erased schematic data to be used generically. In order for this to work correctly, it is important to remember to register schematics to the type registry along with the ReflectSchematic type data.

Registration must happen manually via App::register_type or with App::register_type_data (which will register type data and the type if it hasn’t been registered already). The ReflectSchematic type data can be registered using App::register_type_data or by including #[reflect(Schematic)] on the type definition.

Entity-ness

Currently, schematics are applied and removed on a per-entity basis. This means that even if a schematic doesn’t require an entity, it will still be given one on which to operate.

In the future, this requirement will be lifted and schematics will be able to request that an entity not be spawned when it’s applied.

Structs

• DynamicSchematic
  A dynamic representation of a Schematic.
• ReflectSchematic
  Reflected type data for the Schematic trait.
• SchematicContext
  The context in which a schematic instance exists.
• Schematics
  A collection of schematics for a prototype.

Enums

• SchematicError
  Schematic-related error.

Traits

• FromSchematicInput
  A custom From-like trait used to convert the input of a schematic to itself.
• Schematic
  Trait used to create a prototype schematic for modifying an entity (or the world in general).

Derive Macros

• Schematic
  Derive the Schematic trait.