 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.
		
			
				
	
	
		
			52 lines
		
	
	
		
			1.6 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			52 lines
		
	
	
		
			1.6 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! Renders an animated sprite by loading all animation frames from a single image (a sprite sheet)
 | |
| //! into a texture atlas, and changing the displayed image periodically.
 | |
| 
 | |
| use bevy::prelude::*;
 | |
| 
 | |
| fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_startup_system(setup)
 | |
|         .add_system(animate_sprite)
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| #[derive(Component, Deref, DerefMut)]
 | |
| struct AnimationTimer(Timer);
 | |
| 
 | |
| fn animate_sprite(
 | |
|     time: Res<Time>,
 | |
|     texture_atlases: Res<Assets<TextureAtlas>>,
 | |
|     mut query: Query<(
 | |
|         &mut AnimationTimer,
 | |
|         &mut TextureAtlasSprite,
 | |
|         &Handle<TextureAtlas>,
 | |
|     )>,
 | |
| ) {
 | |
|     for (mut timer, mut sprite, texture_atlas_handle) in query.iter_mut() {
 | |
|         timer.tick(time.delta());
 | |
|         if timer.just_finished() {
 | |
|             let texture_atlas = texture_atlases.get(texture_atlas_handle).unwrap();
 | |
|             sprite.index = (sprite.index + 1) % texture_atlas.textures.len();
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn setup(
 | |
|     mut commands: Commands,
 | |
|     asset_server: Res<AssetServer>,
 | |
|     mut texture_atlases: ResMut<Assets<TextureAtlas>>,
 | |
| ) {
 | |
|     let texture_handle = asset_server.load("textures/rpg/chars/gabe/gabe-idle-run.png");
 | |
|     let texture_atlas = TextureAtlas::from_grid(texture_handle, Vec2::new(24.0, 24.0), 7, 1);
 | |
|     let texture_atlas_handle = texture_atlases.add(texture_atlas);
 | |
|     commands.spawn_bundle(OrthographicCameraBundle::new_2d());
 | |
|     commands
 | |
|         .spawn_bundle(SpriteSheetBundle {
 | |
|             texture_atlas: texture_atlas_handle,
 | |
|             transform: Transform::from_scale(Vec3::splat(6.0)),
 | |
|             ..default()
 | |
|         })
 | |
|         .insert(AnimationTimer(Timer::from_seconds(0.1, true)));
 | |
| }
 |