mirror of
https://github.com/bevyengine/bevy
synced 2024-11-24 21:53:07 +00:00
Some docs for IntoSystemSet (#10563)
Co-authored-by: Pascal Hertleif <killercup@gmail.com> Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
This commit is contained in:
parent
1c5c972e14
commit
17e509748d
1 changed files with 39 additions and 0 deletions
|
@ -206,6 +206,39 @@ impl<T> NodeConfigs<T> {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Types that can convert into a [`SystemConfigs`].
|
/// Types that can convert into a [`SystemConfigs`].
|
||||||
|
///
|
||||||
|
/// This trait is implemented for "systems" (functions whose arguments all implement
|
||||||
|
/// [`SystemParam`](crate::system::SystemParam)), or tuples thereof.
|
||||||
|
/// It is a common entry point for system configurations.
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # use bevy_ecs::schedule::IntoSystemConfigs;
|
||||||
|
/// # struct AppMock;
|
||||||
|
/// # struct Update;
|
||||||
|
/// # impl AppMock {
|
||||||
|
/// # pub fn add_systems<M>(
|
||||||
|
/// # &mut self,
|
||||||
|
/// # schedule: Update,
|
||||||
|
/// # systems: impl IntoSystemConfigs<M>,
|
||||||
|
/// # ) -> &mut Self { self }
|
||||||
|
/// # }
|
||||||
|
/// # let mut app = AppMock;
|
||||||
|
///
|
||||||
|
/// fn handle_input() {}
|
||||||
|
///
|
||||||
|
/// fn update_camera() {}
|
||||||
|
/// fn update_character() {}
|
||||||
|
///
|
||||||
|
/// app.add_systems(
|
||||||
|
/// Update,
|
||||||
|
/// (
|
||||||
|
/// handle_input,
|
||||||
|
/// (update_camera, update_character).after(handle_input)
|
||||||
|
/// )
|
||||||
|
/// );
|
||||||
|
/// ```
|
||||||
pub trait IntoSystemConfigs<Marker>
|
pub trait IntoSystemConfigs<Marker>
|
||||||
where
|
where
|
||||||
Self: Sized,
|
Self: Sized,
|
||||||
|
@ -221,11 +254,17 @@ where
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Run before all systems in `set`.
|
/// Run before all systems in `set`.
|
||||||
|
///
|
||||||
|
/// Note: The given set is not implicitly added to the schedule when this system set is added.
|
||||||
|
/// It is safe, but no dependencies will be created.
|
||||||
fn before<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs {
|
fn before<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs {
|
||||||
self.into_configs().before(set)
|
self.into_configs().before(set)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Run after all systems in `set`.
|
/// Run after all systems in `set`.
|
||||||
|
///
|
||||||
|
/// Note: The given set is not implicitly added to the schedule when this system set is added.
|
||||||
|
/// It is safe, but no dependencies will be created.
|
||||||
fn after<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs {
|
fn after<M>(self, set: impl IntoSystemSet<M>) -> SystemConfigs {
|
||||||
self.into_configs().after(set)
|
self.into_configs().after(set)
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue