mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
Better doc for SystemName (#11084)
Compared to [current documentation](https://docs.rs/bevy/latest/bevy/ecs/system/struct.SystemName.html) it is now immediately clear that it is `SystemParam` readily available to user, and not just some accidentally exposed internal data type.
This commit is contained in:
parent
13feac6721
commit
ac58a5fe57
1 changed files with 25 additions and 3 deletions
|
@ -1287,10 +1287,32 @@ unsafe impl SystemParam for SystemChangeTick {
|
|||
}
|
||||
}
|
||||
|
||||
/// Name of the system that corresponds to this [`crate::system::SystemState`].
|
||||
/// [`SystemParam`] that returns the name of the system which it is used in.
|
||||
///
|
||||
/// This is not a reliable identifier, it is more so useful for debugging
|
||||
/// purposes of finding where a system parameter is being used incorrectly.
|
||||
/// This is not a reliable identifier, it is more so useful for debugging or logging.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # use bevy_ecs::system::SystemName;
|
||||
/// # use bevy_ecs::system::SystemParam;
|
||||
///
|
||||
/// #[derive(SystemParam)]
|
||||
/// struct Logger<'s> {
|
||||
/// system_name: SystemName<'s>,
|
||||
/// }
|
||||
///
|
||||
/// impl<'s> Logger<'s> {
|
||||
/// fn log(&mut self, message: &str) {
|
||||
/// eprintln!("{}: {}", self.system_name, message);
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// fn system1(mut logger: Logger) {
|
||||
/// // Prints: "crate_name::mod_name::system1: Hello".
|
||||
/// logger.log("Hello");
|
||||
/// }
|
||||
/// ```
|
||||
#[derive(Debug)]
|
||||
pub struct SystemName<'s>(&'s str);
|
||||
|
||||
|
|
Loading…
Reference in a new issue