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

Fix panics and docs when using World schedules (#8364)

Browse Source 
# Objective

The method `World::try_run_schedule` currently panics if the `Schedules`
resource does not exist, but it should just return an `Err`. Similarly,
`World::add_schedule` panics unnecessarily if the resource does not
exist.

Also, the documentation for `World::add_schedule` is completely wrong.

## Solution

When the `Schedules` resource does not exist, we now treat it the same
as if it did exist but was empty. When calling `add_schedule`, we
initialize it if it does not exist.
This commit is contained in:
JoJoJet 2023-04-12 15:29:08 -04:00 committed by GitHub
parent 14abff99f6
commit f3c7ccefc6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
crates/bevy_ecs/src/world/mod.rs
View File

@ -1708,11 +1708,13 @@ impl World {
// Schedule-related methods // Schedule-related methods
impl World { 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) { 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); schedules.insert(label, schedule);
} }
@ -1743,7 +1745,9 @@ impl World {
&mut self, &mut self,
label: &dyn ScheduleLabel, label: &dyn ScheduleLabel,
) -> Result<(), TryRunScheduleError> { ) -> 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())); return Err(TryRunScheduleError(label.dyn_clone()));
}; };