Struct iyes_scene_tools::SceneBuilder

pub struct SceneBuilder<'w> { /* private fields */ }

Flexible tool for creating Bevy scenes

You can select what entities from your World you would like to include in the scene, by adding them using the various methods.

For each entity, you can choose whether you would like to include all components (that impl Reflect) or just a specific set.

See the documentation of the various methods for more info.

After you are done adding entities and components, you can call .build_scene(...) to create a [DynamicScene] with everything that was selected.

Implementations

impl<'w> SceneBuilder<'w>

pub fn new(world: &'w mut World) -> SceneBuilder<'w>

Create a new scene builder

The entities and components of the created scene will come from the provided world.

pub fn ignore_components<Q>(&mut self) -> &mut Selfwhere
    Q: ComponentList,

Add components to the set of components to be ignored

This applies only to entities without explicit component selections.

If you have explicitly added any of them to specific entities, they will still be exported to the scene.

If an entity was added in “all components” mode, then .build_scene() will skip any of these components that it encounters.

pub fn add_from_query_filter<F>(&mut self) -> &mut Selfwhere
    F: ReadOnlyWorldQuery + 'static,

Add all entities that match the given query filter

This method allows you to select entities in a way similar to using Bevy query filters.

All components of each entity will be included.

If you want to only include specific components, try:

• [add_with_components]

pub fn add_entity(&mut self, e: Entity) -> &mut Self

Add a specific entity

The entity ID provided will be added, if it has not been already.

All components of the entity will be included.

If you want to only include specific components, try:

• [add_components_to_entity]

pub fn add_components_to_entity<Q>(&mut self, e: Entity) -> &mut Selfwhere
    Q: ComponentList,

Include the specified components on a given entity ID

The entity ID provided will be added, if it has not been already.

The components listed in Q will be added its component selection.

If you want to select all components, try:

• [add_entity]

pub fn add_entities<I>(&mut self, entities: I) -> &mut Selfwhere
    I: IntoIterator<Item = Entity>,

Add entities by ID

The entity IDs provided will be added, if they have not been already.

All components of each entity will be included.

If you want to only include specific components, try:

• [add_components_to_entities]

pub fn add_components_to_entities<I, Q>(&mut self, entities: I) -> &mut Selfwhere
    I: IntoIterator<Item = Entity>,
    Q: ComponentList,

Include the specified components to entities with ID

The entity IDs provided will be added, if they have not been already.

The components listed in Q will be added their component selections.

If you want to select all components, try:

• [add_entities]

pub fn add_with_components<Q, F>(&mut self) -> &mut Selfwhere
    Q: ComponentList,
    F: ReadOnlyWorldQuery + 'static,

Add specific components to entities that match a query filter

This method allows you to select entities in a way similar to using Bevy query filters.

The components listed in Q will be added to each of the entities.

If you want to select all components, try:

• [add_from_query_filter]

pub fn build_scene(&self) -> DynamicScene

Build a [DynamicScene] with the selected entities and components

Everything that was added to the builder (using the various add_* methods) will be included in the scene.

All the relevant data will be copied from the World that was provided when the SceneBuilder was created.

pub fn export_to_file(
    &self,
    path: impl AsRef<Path>
) -> Result<DynamicScene, SceneExportError>

Convenience method: build the scene and serialize to file

Creates a file in the Bevy Scene RON format. Path should end in .scn.ron.

On success (if both scene generation and file output succeed), will return the generated [DynamicScene], just in case you need it.

pub fn build_scene_and_add(&mut self) -> Handle<DynamicScene>

Convenience method: build the scene and add to the app’s asset collection

Returns an asset handle that can be used for spawning the scene, (with [DynamicSceneBundle]).