mirror of
https://github.com/bevyengine/bevy
synced 2024-11-22 12:43:34 +00:00
42e6dc8987
# Objective - The current `EventReader::iter` has been determined to cause confusion among new Bevy users. It was suggested by @JoJoJet to rename the method to better clarify its usage. - Solves #9624 ## Solution - Rename `EventReader::iter` to `EventReader::read`. - Rename `EventReader::iter_with_id` to `EventReader::read_with_id`. - Rename `ManualEventReader::iter` to `ManualEventReader::read`. - Rename `ManualEventReader::iter_with_id` to `ManualEventReader::read_with_id`. --- ## Changelog - `EventReader::iter` has been renamed to `EventReader::read`. - `EventReader::iter_with_id` has been renamed to `EventReader::read_with_id`. - `ManualEventReader::iter` has been renamed to `ManualEventReader::read`. - `ManualEventReader::iter_with_id` has been renamed to `ManualEventReader::read_with_id`. - Deprecated `EventReader::iter` - Deprecated `EventReader::iter_with_id` - Deprecated `ManualEventReader::iter` - Deprecated `ManualEventReader::iter_with_id` ## Migration Guide - Existing usages of `EventReader::iter` and `EventReader::iter_with_id` will have to be changed to `EventReader::read` and `EventReader::read_with_id` respectively. - Existing usages of `ManualEventReader::iter` and `ManualEventReader::iter_with_id` will have to be changed to `ManualEventReader::read` and `ManualEventReader::read_with_id` respectively.
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_systems(Update, (event_trigger, event_listener, sound_player))
|
|
.run();
|
|
}
|
|
|
|
#[derive(Event)]
|
|
struct MyEvent {
|
|
pub message: String,
|
|
}
|
|
|
|
#[derive(Event, Default)]
|
|
struct PlaySound;
|
|
|
|
#[derive(Resource)]
|
|
struct EventTriggerState {
|
|
event_timer: Timer,
|
|
}
|
|
|
|
impl Default for EventTriggerState {
|
|
fn default() -> Self {
|
|
EventTriggerState {
|
|
event_timer: Timer::from_seconds(1.0, TimerMode::Repeating),
|
|
}
|
|
}
|
|
}
|
|
|
|
// 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.read() {
|
|
info!("{}", my_event.message);
|
|
}
|
|
}
|
|
|
|
fn sound_player(mut play_sound_events: EventReader<PlaySound>) {
|
|
for _ in play_sound_events.read() {
|
|
info!("Playing a sound");
|
|
}
|
|
}
|