mirror of
https://github.com/bevyengine/bevy
synced 2024-11-27 07:00:18 +00:00
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.
63 lines
1.5 KiB
Rust
63 lines
1.5 KiB
Rust
//! This example creates a new event, a system that triggers the event once per second,
|
|
//! and a system that prints a message whenever the event is received.
|
|
|
|
use bevy::prelude::*;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_event::<MyEvent>()
|
|
.add_event::<PlaySound>()
|
|
.init_resource::<EventTriggerState>()
|
|
.add_system(event_trigger)
|
|
.add_system(event_listener)
|
|
.add_system(sound_player)
|
|
.run();
|
|
}
|
|
|
|
struct MyEvent {
|
|
pub message: String,
|
|
}
|
|
|
|
#[derive(Default)]
|
|
struct PlaySound;
|
|
|
|
struct EventTriggerState {
|
|
event_timer: Timer,
|
|
}
|
|
|
|
impl Default for EventTriggerState {
|
|
fn default() -> Self {
|
|
EventTriggerState {
|
|
event_timer: Timer::from_seconds(1.0, true),
|
|
}
|
|
}
|
|
}
|
|
|
|
// sends MyEvent and PlaySound every second
|
|
fn event_trigger(
|
|
time: Res<Time>,
|
|
mut state: ResMut<EventTriggerState>,
|
|
mut my_events: EventWriter<MyEvent>,
|
|
mut play_sound_events: EventWriter<PlaySound>,
|
|
) {
|
|
if state.event_timer.tick(time.delta()).finished() {
|
|
my_events.send(MyEvent {
|
|
message: "MyEvent just happened!".to_string(),
|
|
});
|
|
play_sound_events.send_default();
|
|
}
|
|
}
|
|
|
|
// prints events as they come in
|
|
fn event_listener(mut events: EventReader<MyEvent>) {
|
|
for my_event in events.iter() {
|
|
info!("{}", my_event.message);
|
|
}
|
|
}
|
|
|
|
fn sound_player(mut play_sound_events: EventReader<PlaySound>) {
|
|
for _ in play_sound_events.iter() {
|
|
info!("Playing a sound");
|
|
}
|
|
}
|