forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

scene: rename "spawn" to "instance"

Browse Source
This commit is contained in:
Carter Anderson 2020-08-02 12:57:30 -07:00
parent bb111cbafa
commit 3c1494eb64
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/bevy_scene/src/scene_spawner.rs
View File

@ -39,7 +39,7 @@ pub enum SceneSpawnError {
}
impl SceneSpawner {
pub fn spawn(&mut self, scene_handle: Handle<Scene>) {
pub fn instance(&mut self, scene_handle: Handle<Scene>) {
self.scenes_to_spawn.push(scene_handle);
}

12
examples/scene/load_scene.rs
View File

@ -55,15 +55,15 @@ fn load_scene_system(asset_server: Res<AssetServer>, mut scene_spawner: ResMut<S
.load("assets/scenes/load_scene_example.scn")
.unwrap();
// SceneSpawner can "spawn" scenes. "spawning" a scene creates a new instance of the scene in the World with new entity ids.
// SceneSpawner can "instance" scenes. "instancing" a scene creates a new instance of the scene in the World with new entity ids.
// This guarantees that it will not overwrite existing entities.
scene_spawner.spawn(scene_handle);
scene_spawner.instance(scene_handle);
// SceneSpawner can also "load" scenes. "loading" a scene preserves the entity ids in the scene.
// In general, you should "spawn" scenes when you are dynamically composing your World and "load" scenes for things like game saves.
// In general, you should "instance" scenes when you are dynamically composing your World and "load" scenes for things like game saves.
scene_spawner.load(scene_handle);
// we have now loaded `scene_handle` AND spawned it, which means our World now has one set of entities with the Scene's ids and
// we have now loaded `scene_handle` AND instanced it, which means our World now has one set of entities with the Scene's ids and
// one set of entities with new ids
// This tells the AssetServer to watch for changes to assets.
@ -71,10 +71,10 @@ fn load_scene_system(asset_server: Res<AssetServer>, mut scene_spawner: ResMut<S
asset_server.watch_for_changes().unwrap();
}
// Using SceneSpawner spawn() and load() queues them up to be added to the World at the beginning of the next update. However if
// Using SceneSpawner instance() and load() queues them up to be added to the World at the beginning of the next update. However if
// you need scenes to load immediately, you can use the following approach. But be aware that this takes full control of the ECS world
// and therefore blocks other parallel systems from executing until it finishes. In most cases you should use the SceneSpawner
// spawn() and load() methods.
// instance() and load() methods.
#[allow(dead_code)]
fn load_scene_right_now_system(world: &mut World, resources: &mut Resources) {
let scene_handle: Handle<Scene> = {