 1ba7429371
			
		
	
	
		1ba7429371
		
	
	
	
	
		
			
			# Objective Provide a starting point for #3951, or a partial solution. Providing a few comment blocks to discuss, and hopefully find better one in the process. ## Solution Since I am pretty new to pretty much anything in this context, I figured I'd just start with a draft for some file level doc blocks. For some of them I found more relevant details (or at least things I considered interessting), for some others there is less. ## Changelog - Moved some existing comments from main() functions in the 2d examples to the file header level - Wrote some more comment blocks for most other 2d examples TODO: - [x] 2d/sprite_sheet, wasnt able to come up with something good yet - [x] all other example groups... Also: Please let me know if the commit style is okay, or to verbose. I could certainly squash these things, or add more details if needed. I also hope its okay to raise this PR this early, with just a few files changed. Took me long enough and I dont wanted to let it go to waste because I lost motivation to do the whole thing. Additionally I am somewhat uncertain over the style and contents of the commets. So let me know what you thing please.
		
			
				
	
	
		
			53 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			53 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! This example illustrates how to react to component change.
 | |
| 
 | |
| use bevy::prelude::*;
 | |
| use rand::Rng;
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_startup_system(setup)
 | |
|         .add_system(change_component)
 | |
|         .add_system(change_detection)
 | |
|         .add_system(tracker_monitoring)
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| #[derive(Component, Debug)]
 | |
| struct MyComponent(f64);
 | |
| 
 | |
| fn setup(mut commands: Commands) {
 | |
|     commands.spawn().insert(MyComponent(0.));
 | |
|     commands.spawn().insert(Transform::identity());
 | |
| }
 | |
| 
 | |
| fn change_component(time: Res<Time>, mut query: Query<(Entity, &mut MyComponent)>) {
 | |
|     for (entity, mut component) in query.iter_mut() {
 | |
|         if rand::thread_rng().gen_bool(0.1) {
 | |
|             info!("changing component {:?}", entity);
 | |
|             component.0 = time.seconds_since_startup();
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| // There are query filters for `Changed<T>` and `Added<T>`
 | |
| // Only entities matching the filters will be in the query
 | |
| fn change_detection(query: Query<(Entity, &MyComponent), Changed<MyComponent>>) {
 | |
|     for (entity, component) in query.iter() {
 | |
|         info!("{:?} changed: {:?}", entity, component,);
 | |
|     }
 | |
| }
 | |
| 
 | |
| // By looking at trackers, the query is not filtered but the information is available
 | |
| fn tracker_monitoring(
 | |
|     query: Query<(
 | |
|         Entity,
 | |
|         Option<&MyComponent>,
 | |
|         Option<ChangeTrackers<MyComponent>>,
 | |
|     )>,
 | |
| ) {
 | |
|     for (entity, component, trackers) in query.iter() {
 | |
|         info!("{:?}: {:?} -> {:?}", entity, component, trackers);
 | |
|     }
 | |
| }
 |