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

Fix panics and docs when using World schedules #8364

Merged
merged 3 commits into from
Apr 12, 2023
Merged

Fix panics and docs when using World schedules #8364

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15906cf
don't panic in `try_run_schedule`
joseph-gio Apr 12, 2023
957173c
make `add_schedule` infallible
joseph-gio Apr 12, 2023
b582e01
rewrite docs for `add_schedule`
joseph-gio Apr 12, 2023
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
12 changes: 8 additions & 4 deletions crates/bevy_ecs/src/world/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1708,11 +1708,13 @@ impl World {

// Schedule-related methods
impl World {
/// Runs the [`Schedule`] associated with the `label` a single time.
/// Adds the specified [`Schedule`] to the world. The schedule can later be run
/// by calling [`.run_schedule(label)`](Self::run_schedule) or by directly
/// accessing the [`Schedules`] resource.
///
/// The [`Schedule`] is fetched from the
/// The `Schedules` resource will be initialized if it does not already exist.
pub fn add_schedule(&mut self, schedule: Schedule, label: impl ScheduleLabel) {
let mut schedules = self.resource_mut::<Schedules>();
let mut schedules = self.get_resource_or_insert_with(Schedules::default);
schedules.insert(label, schedule);
}

Expand Down Expand Up @@ -1743,7 +1745,9 @@ impl World {
&mut self,
label: &dyn ScheduleLabel,
) -> Result<(), TryRunScheduleError> {
let Some((extracted_label, mut schedule)) = self.resource_mut::<Schedules>().remove_entry(label) else {
let Some((extracted_label, mut schedule))
= self.get_resource_mut::<Schedules>().and_then(|mut s| s.remove_entry(label))
else {
return Err(TryRunScheduleError(label.dyn_clone()));
};

Expand Down