2022-10-11 15:21:12 +00:00
|
|
|
//! Illustrates how to make a single system from multiple functions running in sequence,
|
|
|
|
//! passing the output of the first into the input of the next.
|
2022-05-16 13:53:20 +00:00
|
|
|
|
2020-11-17 02:18:00 +00:00
|
|
|
use anyhow::Result;
|
|
|
|
use bevy::prelude::*;
|
|
|
|
|
2022-12-11 18:10:03 +00:00
|
|
|
use bevy::log::LogPlugin;
|
|
|
|
use bevy::utils::tracing::Level;
|
|
|
|
|
2020-11-17 02:18:00 +00:00
|
|
|
fn main() {
|
2021-07-27 20:21:06 +00:00
|
|
|
App::new()
|
2021-01-30 20:55:13 +00:00
|
|
|
.insert_resource(Message("42".to_string()))
|
2022-12-11 18:10:03 +00:00
|
|
|
.insert_resource(OptionalWarning(Err("Got to rusty?".to_string())))
|
|
|
|
.add_plugin(LogPlugin {
|
|
|
|
level: Level::TRACE,
|
|
|
|
filter: "".to_string(),
|
|
|
|
})
|
2022-10-11 15:21:12 +00:00
|
|
|
.add_system(parse_message_system.pipe(handler_system))
|
2022-12-11 18:10:03 +00:00
|
|
|
.add_system(data_pipe_system.pipe(info))
|
|
|
|
.add_system(parse_message_system.pipe(dbg))
|
|
|
|
.add_system(warning_pipe_system.pipe(warn))
|
|
|
|
.add_system(parse_error_message_system.pipe(error))
|
|
|
|
.add_system(parse_message_system.pipe(ignore))
|
2020-11-17 02:18:00 +00:00
|
|
|
.run();
|
|
|
|
}
|
|
|
|
|
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, Deref)]
|
2020-11-17 02:18:00 +00:00
|
|
|
struct Message(String);
|
|
|
|
|
2022-12-11 18:10:03 +00:00
|
|
|
#[derive(Resource, Deref)]
|
|
|
|
struct OptionalWarning(Result<(), String>);
|
|
|
|
|
|
|
|
// This system produces a Result<usize> output by trying to parse the Message resource.
|
2020-11-17 02:18:00 +00:00
|
|
|
fn parse_message_system(message: Res<Message>) -> Result<usize> {
|
bevy_derive: Add derives for `Deref` and `DerefMut` (#4328)
# Objective
A common pattern in Rust is the [newtype](https://doc.rust-lang.org/rust-by-example/generics/new_types.html). This is an especially useful pattern in Bevy as it allows us to give common/foreign types different semantics (such as allowing it to implement `Component` or `FromWorld`) or to simply treat them as a "new type" (clever). For example, it allows us to wrap a common `Vec<String>` and do things like:
```rust
#[derive(Component)]
struct Items(Vec<String>);
fn give_sword(query: Query<&mut Items>) {
query.single_mut().0.push(String::from("Flaming Poisoning Raging Sword of Doom"));
}
```
> We could then define another struct that wraps `Vec<String>` without anything clashing in the query.
However, one of the worst parts of this pattern is the ugly `.0` we have to write in order to access the type we actually care about. This is why people often implement `Deref` and `DerefMut` in order to get around this.
Since it's such a common pattern, especially for Bevy, it makes sense to add a derive macro to automatically add those implementations.
## Solution
Added a derive macro for `Deref` and another for `DerefMut` (both exported into the prelude). This works on all structs (including tuple structs) as long as they only contain a single field:
```rust
#[derive(Deref)]
struct Foo(String);
#[derive(Deref, DerefMut)]
struct Bar {
name: String,
}
```
This allows us to then remove that pesky `.0`:
```rust
#[derive(Component, Deref, DerefMut)]
struct Items(Vec<String>);
fn give_sword(query: Query<&mut Items>) {
query.single_mut().push(String::from("Flaming Poisoning Raging Sword of Doom"));
}
```
### Alternatives
There are other alternatives to this such as by using the [`derive_more`](https://crates.io/crates/derive_more) crate. However, it doesn't seem like we need an entire crate just yet since we only need `Deref` and `DerefMut` (for now).
### Considerations
One thing to consider is that the Rust std library recommends _not_ using `Deref` and `DerefMut` for things like this: "`Deref` should only be implemented for smart pointers to avoid confusion" ([reference](https://doc.rust-lang.org/std/ops/trait.Deref.html)). Personally, I believe it makes sense to use it in the way described above, but others may disagree.
### Additional Context
Discord: https://discord.com/channels/691052431525675048/692572690833473578/956648422163746827 (controversiality discussed [here](https://discord.com/channels/691052431525675048/692572690833473578/956711911481835630))
---
## Changelog
- Add `Deref` derive macro (exported to prelude)
- Add `DerefMut` derive macro (exported to prelude)
- Updated most newtypes in examples to use one or both derives
Co-authored-by: MrGVSV <49806985+MrGVSV@users.noreply.github.com>
2022-03-29 02:10:06 +00:00
|
|
|
Ok(message.parse::<usize>()?)
|
2020-11-17 02:18:00 +00:00
|
|
|
}
|
|
|
|
|
2022-12-11 18:10:03 +00:00
|
|
|
// This system produces a Result<()> output by trying to parse the Message resource.
|
|
|
|
fn parse_error_message_system(message: Res<Message>) -> Result<()> {
|
|
|
|
message.parse::<usize>()?;
|
|
|
|
Ok(())
|
|
|
|
}
|
|
|
|
|
2020-11-17 02:18:00 +00:00
|
|
|
// This system takes a Result<usize> input and either prints the parsed value or the error message
|
2021-03-11 00:27:30 +00:00
|
|
|
// Try changing the Message resource to something that isn't an integer. You should see the error
|
|
|
|
// message printed.
|
2020-11-17 02:18:00 +00:00
|
|
|
fn handler_system(In(result): In<Result<usize>>) {
|
|
|
|
match result {
|
2022-10-28 21:03:01 +00:00
|
|
|
Ok(value) => println!("parsed message: {value}"),
|
|
|
|
Err(err) => println!("encountered an error: {err:?}"),
|
2020-11-17 02:18:00 +00:00
|
|
|
}
|
|
|
|
}
|
2022-12-11 18:10:03 +00:00
|
|
|
|
|
|
|
// This system produces a String output by trying to clone the String from the Message resource.
|
|
|
|
fn data_pipe_system(message: Res<Message>) -> String {
|
|
|
|
message.0.clone()
|
|
|
|
}
|
|
|
|
|
|
|
|
// This system produces an Result<String> output by trying to extract a String from the
|
|
|
|
// OptionalWarning resource. Try changing the OptionalWarning resource to None. You should
|
|
|
|
// not see the warning message printed.
|
|
|
|
fn warning_pipe_system(message: Res<OptionalWarning>) -> Result<(), String> {
|
|
|
|
message.0.clone()
|
|
|
|
}
|