2022-05-16 13:53:20 +00:00
|
|
|
//! 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.
|
|
|
|
|
2020-03-30 06:51:13 +00:00
|
|
|
use bevy::prelude::*;
|
|
|
|
|
|
|
|
fn main() {
|
2021-07-27 20:21:06 +00:00
|
|
|
App::new()
|
2020-11-03 03:01:17 +00:00
|
|
|
.add_plugins(DefaultPlugins)
|
2020-03-30 06:51:13 +00:00
|
|
|
.add_event::<MyEvent>()
|
2022-02-04 01:24:47 +00:00
|
|
|
.add_event::<PlaySound>()
|
2020-05-13 23:35:38 +00:00
|
|
|
.init_resource::<EventTriggerState>()
|
2023-03-18 01:45:34 +00:00
|
|
|
.add_systems(Update, (event_trigger, event_listener, sound_player))
|
2020-03-30 06:51:13 +00:00
|
|
|
.run();
|
|
|
|
}
|
|
|
|
|
2023-06-06 14:44:32 +00:00
|
|
|
#[derive(Event)]
|
2020-04-28 09:31:01 +00:00
|
|
|
struct MyEvent {
|
|
|
|
pub message: String,
|
|
|
|
}
|
|
|
|
|
2023-06-06 14:44:32 +00:00
|
|
|
#[derive(Event, Default)]
|
2022-02-04 01:24:47 +00:00
|
|
|
struct PlaySound;
|
|
|
|
|
Make `Resource` trait opt-in, requiring `#[derive(Resource)]` V2 (#5577)
*This PR description is an edited copy of #5007, written by @alice-i-cecile.*
# Objective
Follow-up to https://github.com/bevyengine/bevy/pull/2254. The `Resource` trait currently has a blanket implementation for all types that meet its bounds.
While ergonomic, this results in several drawbacks:
* it is possible to make confusing, silent mistakes such as inserting a function pointer (Foo) rather than a value (Foo::Bar) as a resource
* it is challenging to discover if a type is intended to be used as a resource
* we cannot later add customization options (see the [RFC](https://github.com/bevyengine/rfcs/blob/main/rfcs/27-derive-component.md) for the equivalent choice for Component).
* dependencies can use the same Rust type as a resource in invisibly conflicting ways
* raw Rust types used as resources cannot preserve privacy appropriately, as anyone able to access that type can read and write to internal values
* we cannot capture a definitive list of possible resources to display to users in an editor
## Notes to reviewers
* Review this commit-by-commit; there's effectively no back-tracking and there's a lot of churn in some of these commits.
*ira: My commits are not as well organized :')*
* I've relaxed the bound on Local to Send + Sync + 'static: I don't think these concerns apply there, so this can keep things simple. Storing e.g. a u32 in a Local is fine, because there's a variable name attached explaining what it does.
* I think this is a bad place for the Resource trait to live, but I've left it in place to make reviewing easier. IMO that's best tackled with https://github.com/bevyengine/bevy/issues/4981.
## Changelog
`Resource` is no longer automatically implemented for all matching types. Instead, use the new `#[derive(Resource)]` macro.
## Migration Guide
Add `#[derive(Resource)]` to all types you are using as a resource.
If you are using a third party type as a resource, wrap it in a tuple struct to bypass orphan rules. Consider deriving `Deref` and `DerefMut` to improve ergonomics.
`ClearColor` no longer implements `Component`. Using `ClearColor` as a component in 0.8 did nothing.
Use the `ClearColorConfig` in the `Camera3d` and `Camera2d` components instead.
Co-authored-by: Alice <alice.i.cecile@gmail.com>
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
Co-authored-by: devil-ira <justthecooldude@gmail.com>
Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2022-08-08 21:36:35 +00:00
|
|
|
#[derive(Resource)]
|
2020-04-28 09:31:01 +00:00
|
|
|
struct EventTriggerState {
|
2020-06-04 02:53:41 +00:00
|
|
|
event_timer: Timer,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Default for EventTriggerState {
|
|
|
|
fn default() -> Self {
|
|
|
|
EventTriggerState {
|
Replace the `bool` argument of `Timer` with `TimerMode` (#6247)
As mentioned in #2926, it's better to have an explicit type that clearly communicates the intent of the timer mode rather than an opaque boolean, which can be only understood when knowing the signature or having to look up the documentation.
This also opens up a way to merge different timers, such as `Stopwatch`, and possibly future ones, such as `DiscreteStopwatch` and `DiscreteTimer` from #2683, into one struct.
Signed-off-by: Lena Milizé <me@lvmn.org>
# Objective
Fixes #2926.
## Solution
Introduce `TimerMode` which replaces the `bool` argument of `Timer` constructors. A `Default` value for `TimerMode` is `Once`.
---
## Changelog
### Added
- `TimerMode` enum, along with variants `TimerMode::Once` and `TimerMode::Repeating`
### Changed
- Replace `bool` argument of `Timer::new` and `Timer::from_seconds` with `TimerMode`
- Change `repeating: bool` field of `Timer` with `mode: TimerMode`
## Migration Guide
- Replace `Timer::new(duration, false)` with `Timer::new(duration, TimerMode::Once)`.
- Replace `Timer::new(duration, true)` with `Timer::new(duration, TimerMode::Repeating)`.
- Replace `Timer::from_seconds(seconds, false)` with `Timer::from_seconds(seconds, TimerMode::Once)`.
- Replace `Timer::from_seconds(seconds, true)` with `Timer::from_seconds(seconds, TimerMode::Repeating)`.
- Change `timer.repeating()` to `timer.mode() == TimerMode::Repeating`.
2022-10-17 13:47:01 +00:00
|
|
|
event_timer: Timer::from_seconds(1.0, TimerMode::Repeating),
|
2020-06-04 02:53:41 +00:00
|
|
|
}
|
|
|
|
}
|
2020-04-28 09:31:01 +00:00
|
|
|
}
|
|
|
|
|
2022-02-04 01:24:47 +00:00
|
|
|
// sends MyEvent and PlaySound every second
|
|
|
|
fn event_trigger(
|
2020-06-04 02:53:41 +00:00
|
|
|
time: Res<Time>,
|
2020-05-14 00:52:47 +00:00
|
|
|
mut state: ResMut<EventTriggerState>,
|
2021-03-07 20:42:04 +00:00
|
|
|
mut my_events: EventWriter<MyEvent>,
|
2022-02-04 01:24:47 +00:00
|
|
|
mut play_sound_events: EventWriter<PlaySound>,
|
2020-04-28 09:31:01 +00:00
|
|
|
) {
|
2021-03-05 19:59:14 +00:00
|
|
|
if state.event_timer.tick(time.delta()).finished() {
|
2020-04-28 09:31:01 +00:00
|
|
|
my_events.send(MyEvent {
|
2020-05-01 20:12:47 +00:00
|
|
|
message: "MyEvent just happened!".to_string(),
|
2020-04-28 09:31:01 +00:00
|
|
|
});
|
2022-02-04 01:24:47 +00:00
|
|
|
play_sound_events.send_default();
|
2020-04-28 09:31:01 +00:00
|
|
|
}
|
2020-03-30 06:51:13 +00:00
|
|
|
}
|
|
|
|
|
2020-04-28 09:31:01 +00:00
|
|
|
// prints events as they come in
|
2022-02-04 01:24:47 +00:00
|
|
|
fn event_listener(mut events: EventReader<MyEvent>) {
|
2023-08-30 14:20:03 +00:00
|
|
|
for my_event in events.read() {
|
2021-04-22 23:30:48 +00:00
|
|
|
info!("{}", my_event.message);
|
2020-04-28 09:31:01 +00:00
|
|
|
}
|
2020-04-28 09:52:26 +00:00
|
|
|
}
|
2022-02-04 01:24:47 +00:00
|
|
|
|
|
|
|
fn sound_player(mut play_sound_events: EventReader<PlaySound>) {
|
2023-08-30 14:20:03 +00:00
|
|
|
for _ in play_sound_events.read() {
|
2022-02-04 01:24:47 +00:00
|
|
|
info!("Playing a sound");
|
|
|
|
}
|
|
|
|
}
|