Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Rename Schedule::name to Schedule::label (#11531)

Browse source 
# Objective

While working on #11527 I spotted that the internal field for the label
of a `Schedule` is called `name`. Using `label` seems more in line with
the other naming across Bevy.

## Solution

Renaming the field was straightforward since it's not exposed outside of
the module. This also means a changelog or migration guide isn't
necessary.
This commit is contained in:
Manuel Fuchs 2024-01-25 20:13:23 +01:00 committed by GitHub
parent a93cefe2cf
commit bfb8e9978a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
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_app/src/app.rs
View file

@ -856,7 +856,7 @@ impl App {
/// Adds a new `schedule` to the [`App`]. /// Adds a new `schedule` to the [`App`].
/// ///
/// # Warning /// # Warning
/// This method will overwrite any existing schedule with the same name. /// This method will overwrite any existing schedule with the same label.
/// To avoid this behavior, use the `init_schedule` method instead. /// To avoid this behavior, use the `init_schedule` method instead.
pub fn add_schedule(&mut self, schedule: Schedule) -> &mut Self { pub fn add_schedule(&mut self, schedule: Schedule) -> &mut Self {
let mut schedules = self.world.resource_mut::<Schedules>(); let mut schedules = self.world.resource_mut::<Schedules>();

12
crates/bevy_ecs/src/schedule/schedule.rs
View file

@ -47,7 +47,7 @@ impl Schedules {
/// If the map already had an entry for `label`, `schedule` is inserted, /// If the map already had an entry for `label`, `schedule` is inserted,
/// and the old schedule is returned. Otherwise, `None` is returned. /// and the old schedule is returned. Otherwise, `None` is returned.
pub fn insert(&mut self, schedule: Schedule) -> Option<Schedule> { pub fn insert(&mut self, schedule: Schedule) -> Option<Schedule> {
self.inner.insert(schedule.name, schedule) self.inner.insert(schedule.label, schedule)
} }
/// Removes the schedule corresponding to the `label` from the map, returning it if it existed. /// Removes the schedule corresponding to the `label` from the map, returning it if it existed.
@ -206,7 +206,7 @@ pub enum Chain {
/// } /// }
/// ``` /// ```
pub struct Schedule { pub struct Schedule {
name: InternedScheduleLabel, label: InternedScheduleLabel,
graph: ScheduleGraph, graph: ScheduleGraph,
executable: SystemSchedule, executable: SystemSchedule,
executor: Box<dyn SystemExecutor>, executor: Box<dyn SystemExecutor>,
@ -230,7 +230,7 @@ impl Schedule {
/// Constructs an empty `Schedule`. /// Constructs an empty `Schedule`.
pub fn new(label: impl ScheduleLabel) -> Self { pub fn new(label: impl ScheduleLabel) -> Self {
Self { Self {
name: label.intern(), label: label.intern(),
graph: ScheduleGraph::new(), graph: ScheduleGraph::new(),
executable: SystemSchedule::new(), executable: SystemSchedule::new(),
executor: make_executor(ExecutorKind::default()), executor: make_executor(ExecutorKind::default()),
@ -319,11 +319,11 @@ impl Schedule {
/// Runs all systems in this schedule on the `world`, using its current execution strategy. /// Runs all systems in this schedule on the `world`, using its current execution strategy.
pub fn run(&mut self, world: &mut World) { pub fn run(&mut self, world: &mut World) {
#[cfg(feature = "trace")] #[cfg(feature = "trace")]
let _span = info_span!("schedule", name = ?self.name).entered(); let _span = info_span!("schedule", name = ?self.label).entered();
world.check_change_ticks(); world.check_change_ticks();
self.initialize(world) self.initialize(world)
.unwrap_or_else(|e| panic!("Error when initializing schedule {:?}: {e}", self.name)); .unwrap_or_else(|e| panic!("Error when initializing schedule {:?}: {e}", self.label));
self.executor.run(&mut self.executable, world); self.executor.run(&mut self.executable, world);
} }
@ -342,7 +342,7 @@ impl Schedule {
&mut self.executable, &mut self.executable,
world.components(), world.components(),
&ignored_ambiguities, &ignored_ambiguities,
self.name, self.label,
)?; )?;
self.graph.changed = false; self.graph.changed = false;
self.executor_initialized = false; self.executor_initialized = false;