mirror of
https://github.com/bevyengine/bevy
synced 2024-12-03 01:49:14 +00:00
01aedc8431
# Objective Now that we can consolidate Bundles and Components under a single insert (thanks to #2975 and #6039), almost 100% of world spawns now look like `world.spawn().insert((Some, Tuple, Here))`. Spawning an entity without any components is an extremely uncommon pattern, so it makes sense to give spawn the "first class" ergonomic api. This consolidated api should be made consistent across all spawn apis (such as World and Commands). ## Solution All `spawn` apis (`World::spawn`, `Commands:;spawn`, `ChildBuilder::spawn`, and `WorldChildBuilder::spawn`) now accept a bundle as input: ```rust // before: commands .spawn() .insert((A, B, C)); world .spawn() .insert((A, B, C); // after commands.spawn((A, B, C)); world.spawn((A, B, C)); ``` All existing instances of `spawn_bundle` have been deprecated in favor of the new `spawn` api. A new `spawn_empty` has been added, replacing the old `spawn` api. By allowing `world.spawn(some_bundle)` to replace `world.spawn().insert(some_bundle)`, this opened the door to removing the initial entity allocation in the "empty" archetype / table done in `spawn()` (and subsequent move to the actual archetype in `.insert(some_bundle)`). This improves spawn performance by over 10%:  To take this measurement, I added a new `world_spawn` benchmark. Unfortunately, optimizing `Commands::spawn` is slightly less trivial, as Commands expose the Entity id of spawned entities prior to actually spawning. Doing the optimization would (naively) require assurances that the `spawn(some_bundle)` command is applied before all other commands involving the entity (which would not necessarily be true, if memory serves). Optimizing `Commands::spawn` this way does feel possible, but it will require careful thought (and maybe some additional checks), which deserves its own PR. For now, it has the same performance characteristics of the current `Commands::spawn_bundle` on main. **Note that 99% of this PR is simple renames and refactors. The only code that needs careful scrutiny is the new `World::spawn()` impl, which is relatively straightforward, but it has some new unsafe code (which re-uses battle tested BundlerSpawner code path).** --- ## Changelog - All `spawn` apis (`World::spawn`, `Commands:;spawn`, `ChildBuilder::spawn`, and `WorldChildBuilder::spawn`) now accept a bundle as input - All instances of `spawn_bundle` have been deprecated in favor of the new `spawn` api - World and Commands now have `spawn_empty()`, which is equivalent to the old `spawn()` behavior. ## Migration Guide ```rust // Old (0.8): commands .spawn() .insert_bundle((A, B, C)); // New (0.9) commands.spawn((A, B, C)); // Old (0.8): commands.spawn_bundle((A, B, C)); // New (0.9) commands.spawn((A, B, C)); // Old (0.8): let entity = commands.spawn().id(); // New (0.9) let entity = commands.spawn_empty().id(); // Old (0.8) let entity = world.spawn().id(); // New (0.9) let entity = world.spawn_empty(); ```
74 lines
2.2 KiB
Rust
74 lines
2.2 KiB
Rust
//! Illustrates how to move an object along an axis.
|
|
|
|
use bevy::prelude::*;
|
|
|
|
// Define a struct to keep some information about our entity.
|
|
// Here it's an arbitrary movement speed, the spawn location, and a maximum distance from it.
|
|
#[derive(Component)]
|
|
struct Movable {
|
|
spawn: Vec3,
|
|
max_distance: f32,
|
|
speed: f32,
|
|
}
|
|
|
|
// Implement a utility function for easier Movable struct creation.
|
|
impl Movable {
|
|
fn new(spawn: Vec3) -> Self {
|
|
Movable {
|
|
spawn,
|
|
max_distance: 5.0,
|
|
speed: 2.0,
|
|
}
|
|
}
|
|
}
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_startup_system(setup)
|
|
.add_system(move_cube)
|
|
.run();
|
|
}
|
|
|
|
// Startup system to setup the scene and spawn all relevant entities.
|
|
fn setup(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<StandardMaterial>>,
|
|
) {
|
|
// Add a cube to visualize translation.
|
|
let entity_spawn = Vec3::ZERO;
|
|
commands.spawn((
|
|
PbrBundle {
|
|
mesh: meshes.add(Mesh::from(shape::Cube { size: 1.0 })),
|
|
material: materials.add(Color::WHITE.into()),
|
|
transform: Transform::from_translation(entity_spawn),
|
|
..default()
|
|
},
|
|
Movable::new(entity_spawn),
|
|
));
|
|
|
|
// Spawn a camera looking at the entities to show what's happening in this example.
|
|
commands.spawn(Camera3dBundle {
|
|
transform: Transform::from_xyz(0.0, 10.0, 20.0).looking_at(entity_spawn, Vec3::Y),
|
|
..default()
|
|
});
|
|
|
|
// Add a light source for better 3d visibility.
|
|
commands.spawn(PointLightBundle {
|
|
transform: Transform::from_translation(Vec3::ONE * 3.0),
|
|
..default()
|
|
});
|
|
}
|
|
|
|
// This system will move all Movable entities with a Transform
|
|
fn move_cube(mut cubes: Query<(&mut Transform, &mut Movable)>, timer: Res<Time>) {
|
|
for (mut transform, mut cube) in &mut cubes {
|
|
// Check if the entity moved too far from its spawn, if so invert the moving direction.
|
|
if (cube.spawn - transform.translation).length() > cube.max_distance {
|
|
cube.speed *= -1.0;
|
|
}
|
|
let direction = transform.local_x();
|
|
transform.translation += direction * cube.speed * timer.delta_seconds();
|
|
}
|
|
}
|