Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - Add Commands::new_from_entities #4423

Closed
wants to merge 2 commits into from
Closed

[Merged by Bors] - Add Commands::new_from_entities #4423

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da5e088
add method
TheRawMeatball Apr 5, 2022
0772588
Merge remote-tracking branch 'upstream/main' into commands-from-entities
TheRawMeatball May 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions crates/bevy_ecs/src/system/commands/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ impl<'w, 's> Commands<'w, 's> {
}
}

/// Create a new `Commands` from a queue and an [`Entities`] reference.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should warn that if the commands never get applied, they will never get applied.

I would not be surprised if we had some users not recognising this - at least then we can point them to these docs.

What is the expected usage pattern of this anyway?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The expected usage is creating multiple Commands instances within a par_for_each context. I plan on making a wrapper api as well, so most users won't need to use this directly. As for changing the documentation, I'd argue it's not that necessary given the docs on CommandQueue should cover it.

pub fn new_from_entities(queue: &'s mut CommandQueue, entities: &'w Entities) -> Self {
Self { queue, entities }
}

/// Creates a new empty [`Entity`] and returns an [`EntityCommands`] builder for it.
///
/// To directly spawn an entity with a [`Bundle`] included, you can use
Expand Down